5 Author: Pekka Riikonen <priikone@silcnet.org>
7 Copyright (C) 2002 Pekka Riikonen
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; version 2 of the License.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
20 /****h* silccore/SILC Attribute Interface
24 * Implementation of the Attribute Payload that may be used to send and
25 * retrieve user online precense information in the SILC network. This
26 * implements the draft-riikonen-precense-attrs draft.
33 /****s* silccore/SilcAttributesAPI/SilcAttributePayload
37 * typedef struct SilcAttributePayloadStruct *SilcAttributePayload;
41 * This context is the actual Attribute Payload and is allocated
42 * by silc_attribute_payload_parse and given as attribute usually to
43 * all silc_attribute_payload_* functions. It is freed by the
44 * silc_attribute_payload_free function.
47 typedef struct SilcAttributePayloadStruct *SilcAttributePayload;
49 /****d* silccore/SilcAttributesAPI/SilcAttribute
53 * typedef SilcUInt8 SilcAttribute;
57 * The SilcAttribute type definition and the attributes. The attributes
58 * listed here are the official attributes defined in the internet
59 * draft. They define the contents of the attribute payload and the
60 * type of the attribute.
64 typedef SilcUInt8 SilcAttribute;
66 /* All defined attributes. See the specs for detailed information. The
67 comment is the structure or data type that must be used with the
68 silc_attribute_get_object function to fetch parsed attribute. */
69 #define SILC_ATTRIBUTE_NONE 0
70 #define SILC_ATTRIBUTE_USER_INFO 1 /* SilcVCard */
71 #define SILC_ATTRIBUTE_SERVICE 2 /* SilcAttributeObjService */
72 #define SILC_ATTRIBUTE_STATUS_MOOD 3 /* SilcAttributeMood */
73 #define SILC_ATTRIBUTE_STATUS_FREETEXT 4 /* char * (UTF-8 string) */
74 #define SILC_ATTRIBUTE_STATUS_MESSAGE 5 /* SilcAttributeObjMime */
75 #define SILC_ATTRIBUTE_PREFERRED_LANGUAGE 6 /* char * (UTF-8 string) */
76 #define SILC_ATTRIBUTE_PREFERRED_CONTACT 7 /* SilcAttributeContact */
77 #define SILC_ATTRIBUTE_TIMEZONE 8 /* char * (UTF-8 string) */
78 #define SILC_ATTRIBUTE_GEOLOCATION 9 /* SilcAttributeObjGeo */
79 #define SILC_ATTRIBUTE_DEVICE_INFO 10 /* SilcAttributeObjDevice */
80 #define SILC_ATTRIBUTE_EXTENSION 11 /* SilcAttributeObjMime */
81 #define SILC_ATTRIBUTE_USER_PUBLIC_KEY 12 /* SilcAttributeObjPk */
82 #define SILC_ATTRIBUTE_SERVER_PUBLIC_KEY 13 /* SilcAttributeObjPk */
83 #define SILC_ATTRIBUTE_USER_DIGITAL_SIGNATURE 14 /* SilcAttributeObjPk */
84 #define SILC_ATTRIBUTE_SERVER_DIGITAL_SIGNATURE 15 /* SilcAttributeObjPk */
87 /* Maximum length of attribute request packet */
88 #define SILC_ATTRIBUTE_MAX_REQUEST_LEN (4 * 255)
90 /****d* silccore/SilcAttributesAPI/SilcAttributeFlags
94 * typedef SilcUInt8 SilcAttributeFlags;
98 * Attribute Payload flags defined by the specification.
102 typedef SilcUInt8 SilcAttributeFlags;
104 /* All defined flags */
105 #define SILC_ATTRIBUTE_FLAG_NONE 0x00 /* No flags */
106 #define SILC_ATTRIBUTE_FLAG_INVALID 0x01 /* Invalid attribute */
107 #define SILC_ATTRIBUTE_FLAG_VALID 0x02 /* Valid attribute */
110 /****d* silccore/SilcAttributesAPI/SilcAttributeMood
114 * typedef enum { ... } SilcAttributeMood;
118 * The user mood indicators defined by the specification. This is
124 SILC_ATTRIBUTE_MOOD_NORMAL = 0x00000000, /* normal mood */
125 SILC_ATTRIBUTE_MOOD_HAPPY = 0x00000001, /* user feel happy */
126 SILC_ATTRIBUTE_MOOD_SAD = 0x00000002, /* user feel sad */
127 SILC_ATTRIBUTE_MOOD_ANGRY = 0x00000004, /* user feel angry */
128 SILC_ATTRIBUTE_MOOD_JEALOUS = 0x00000008, /* user feel jealous */
129 SILC_ATTRIBUTE_MOOD_ASHAMED = 0x00000010, /* user feel ashamed */
130 SILC_ATTRIBUTE_MOOD_INVINCIBLE = 0x00000020, /* user feel invincible */
131 SILC_ATTRIBUTE_MOOD_INLOVE = 0x00000040, /* user feel in love */
132 SILC_ATTRIBUTE_MOOD_SLEEPY = 0x00000080, /* user feel sleepy */
133 SILC_ATTRIBUTE_MOOD_BORED = 0x00000100, /* user feel bored */
134 SILC_ATTRIBUTE_MOOD_EXCITED = 0x00000200, /* user feel exited */
135 SILC_ATTRIBUTE_MOOD_ANXIOUS = 0x00000400, /* user feel anxious */
139 /****d* silccore/SilcAttributesAPI/SilcAttributeContact
143 * typedef enum { ... } SilcAttributeContact;
147 * The defined preferred contact methods defined by the specification.
153 SILC_ATTRIBUTE_CONTACT_NONE = 0x00000000, /* no specific method */
154 SILC_ATTRIBUTE_CONTACT_EMAIL = 0x00000001, /* email preferred */
155 SILC_ATTRIBUTE_CONTACT_CALL = 0x00000002, /* phone call preferred */
156 SILC_ATTRIBUTE_CONTACT_PAGE = 0x00000004, /* "paging" preferred */
157 SILC_ATTRIBUTE_CONTACT_SMS = 0x00000008, /* SMS preferred */
158 SILC_ATTRIBUTE_CONTACT_MMS = 0x00000010, /* MMS preferred */
159 SILC_ATTRIBUTE_CONTACT_CHAT = 0x00000020, /* chatting preferred */
160 } SilcAttributeContact;
163 /****d* silccore/SilcAttributesAPI/SilcAttributeDevice
167 * typedef enum { ... } SilcAttributeDevice;
171 * The defined device types defined by the specification.
176 SILC_ATTRIBUTE_DEVICE_COMPUTER = 0, /* device is computer */
177 SILC_ATTRIBUTE_DEVICE_MOBILE_PHONE = 1, /* device is mobile phone */
178 SILC_ATTRIBUTE_DEVICE_PDA = 2, /* device is PDA */
179 SILC_ATTRIBUTE_DEVICE_TERMINAL = 3, /* device is terminal */
180 } SilcAttributeDevice;
183 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_alloc
187 * SilcAttributesPayload
188 * silc_attribute_payload_alloc(SilcAttribute attribute,
189 * SilcAttributeFlags flags,
191 * SilcUInt32 object_size);
195 * Allocates and encodes the attribute indicated by `attribute' and
196 * returns pointer to the attribute.
198 * The `object' must always be the same data type as defined with
199 * SilcAttribute (see the comments) for all attributes.
202 SilcAttributePayload silc_attribute_payload_alloc(SilcAttribute attribute,
203 SilcAttributeFlags flags,
205 SilcUInt32 object_size);
207 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_parse
212 * silc_attribute_payload_parse(const unsigned char *payload,
213 * SilcUInt32 payload_len);
217 * Parses list of Attribute payloads returning list of payloads.
218 * One entry in the returned list is SilcAttributesPayload. You
219 * can produce such a list with silc_attribute_payload_encode
223 SilcDList silc_attribute_payload_parse(const unsigned char *payload,
224 SilcUInt32 payload_len);
226 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_encode
230 * SilcBuffer silc_attribute_payload_encode(SilcBuffer attrs,
231 * SilcAttribute attribute,
232 * SilcAttributeFlags flags,
234 * SilcUInt32 object_size);
238 * Encodes one attribute payload into the `attrs' buffer and returns
239 * pointer to the buffer, which may be different in case the buffer
240 * was reallocated. If `attrs' is NULL for first attribute this
241 * allocates the buffer and returns it. This can be called multiple
242 * times to add multiple attributes to the `attrs' buffer. The `flags'
243 * indicates the validity of the added attribute. Returns NULL on
246 * The `object' must always be the same data type as defined with
247 * SilcAttribute (see the comments) for all attributes.
250 SilcBuffer silc_attribute_payload_encode(SilcBuffer attrs,
251 SilcAttribute attribute,
252 SilcAttributeFlags flags,
254 SilcUInt32 object_size);
256 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_encode_data
261 * silc_attribute_payload_encode_data(SilcBuffer attrs,
262 * SilcAttribute attribute,
263 * SilcAttributeFlags flags,
264 * const unsigned char *data,
265 * SilcUInt32 data_len);
269 * Same function as silc_attribute_payload_encode except the attribute
270 * is already encoded into `data' of `data_len' bytes in length.
271 * Encodes the attribute into the `attrs' buffer and returns pointer
272 * to the buffer, which may be different in case the buffer was
273 * reallocated. If `attrs' is NULL for first attribute this allocates
274 * the buffer and returns it. Returns NULL on error.
277 SilcBuffer silc_attribute_payload_encode_data(SilcBuffer attrs,
278 SilcAttribute attribute,
279 SilcAttributeFlags flags,
280 const unsigned char *data,
281 SilcUInt32 data_len);
283 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_free
287 * void silc_attribute_payload_free(SilcAttributePayload payload);
291 * Frees the Attribute Payload and all data in it.
294 void silc_attribute_payload_free(SilcAttributePayload payload);
296 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_list_free
300 * void silc_attribute_payload_list_free(SilcDList list);
304 * Frees list of Attribute Payloads and all data in them.
307 void silc_attribute_payload_list_free(SilcDList list);
309 /****f* silccore/SilcAttributesAPI/silc_attribute_get_attribute
313 * SilcAttribute silc_attribute_get_attribute(SilcAttributePayload payload);
317 * Return the attribute type from the payload indicated by `payload'.
320 SilcAttribute silc_attribute_get_attribute(SilcAttributePayload payload);
322 /****f* silccore/SilcAttributesAPI/silc_attribute_get_flags
327 * silc_attribute_get_flags(SilcAttributePayload payload);
331 * Return the attribute flags from the payload indicated by `payload'.
334 SilcAttributeFlags silc_attribute_get_flags(SilcAttributePayload payload);
336 /****f* silccore/SilcAttributesAPI/silc_attribute_get_data
340 * const unsigned char *
341 * silc_attribute_get_data(SilcAttributePayload payload,
342 * SilcUInt32 *data_len);
346 * Returns the attribute data from the payload indicated by the `payload'
347 * The caller must not free the returned data pointer.
350 const unsigned char *silc_attribute_get_data(SilcAttributePayload payload,
351 SilcUInt32 *data_len);
353 /****f* silccore/SilcAttributesAPI/silc_attribute_get_verify_data
358 * silc_attribute_get_verify_data(SilcDList attrs,
359 * bool server_verification,
360 * SilcUInt32 *data_len);
364 * Constructs the data to be verified with the sender's digital
365 * signature and sender's public key. This allocates the data from
366 * the list of attribute payloads and returns the buffer. The caller
367 * must free it. If `server_verification' is FALSE then data is
368 * constructed for user's digital signature verification, if it is
369 * TRUE then it is constructed for server's digital signature
373 unsigned char *silc_attribute_get_verify_data(SilcDList attrs,
374 bool server_verification,
375 SilcUInt32 *data_len);
377 /* Object structures */
379 /****s* silccore/SilcAttributesAPI/SilcAttributesObjService
383 * typedef struct { ... } SilcAttributesObjService;
387 * SILC_ATTRIBUTE_SERVICE type object structure.
392 SilcUInt32 port; /* IANA specified service port */
393 char address[256]; /* service address */
394 bool status; /* online status (TRUE present in service) */
395 } SilcAttributeObjService;
398 /****s* silccore/SilcAttributesAPI/SilcAttributesObjMime
402 * typedef struct { ... } SilcAttributesObjMime;
406 * Data type for MIME object as attribute. The data in the structure
407 * is valid as long as the payload structure is valid.
412 const unsigned char *mime; /* MIME buffer */
413 SilcUInt32 mime_len; /* length of the MIME buffer */
414 } SilcAttributeObjMime;
417 /****s* silccore/SilcAttributesAPI/SilcAttributesObjGeo
421 * typedef struct { ... } SilcAttributesObjGeo;
425 * SILC_ATTRIBUTE_GEOLOCATION type object. The caller must free the
426 * strings inside the structure.
431 char *longitude; /* Longitude */
432 char *latitude; /* Latitude */
433 char *altitude; /* Altitude */
434 char *accuracy; /* Accuracy in meters */
435 } SilcAttributeObjGeo;
438 /****s* silccore/SilcAttributesAPI/SilcAttributesObjDevice
442 * typedef struct { ... } SilcAttributesObjDevice;
446 * SILC_ATTRIBUTE_DEVICE_INFO type object. The caller must free the
447 * strings inside the structure.
452 SilcAttributeDevice type; /* device type */
453 char *manufacturer; /* manufacturer of the device */
454 char *version; /* device version string */
455 char *model; /* device model string */
456 char *language; /* device language (ISO 639-2/T) */
457 } SilcAttributeObjDevice;
460 /****s* silccore/SilcAttributesAPI/SilcAttributesObjPk
464 * typedef struct { ... } SilcAttributesObjPk;
468 * Data type for public key, certificate or digital signatures. The
469 * caller must free the data inside the structure.
474 char *type; /* public key/certificate type, NULL
475 when contains digital signature. */
476 unsigned char *data; /* public key/cert/signature data. The
477 encoding depends of the `type'. */
478 SilcUInt32 data_len; /* data length */
479 } SilcAttributeObjPk;
482 /****f* silccore/SilcAttributesAPI/silc_attribute_get_object
486 * bool silc_attribute_get_object(SilcAttributePayload payload,
488 * SilcUInt32 object_size);
492 * Returns the already parsed attribute object from the payload
493 * indicated by `payload'. Copies the data into the `object' which
494 * must be sent as argument (and must be of correct type and size).
495 * The `object_size' indicates the size of the `*object' sent.
496 * Returns TRUE if the `attribute' attribute was found and FALSE
497 * if such attribute is not present in the `payload', or the `object_size'
498 * is not sufficient. See the definition of SilcAttribute for the
499 * list of attributes and the required object types for attributes.
500 * You can use silc_attribute_get_attribute to get the SilcAttribute
501 * type from the `payload'.
504 bool silc_attribute_get_object(SilcAttributePayload payload,
505 void *object, SilcUInt32 object_size);
507 #endif /* SILCATTRS_H */