lib/silccore/silcattrs.h

   1 /*
   2
   3   silcattrs.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2002 - 2005 Pekka Riikonen
   8
   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.
  12
  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.
  17
  18 */
  19
  20 /****h* silccore/SILC Attribute Interface
  21  *
  22  * DESCRIPTION
  23  *
  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.
  27  *
  28  ***/
  29
  30 #ifndef SILCATTRS_H
  31 #define SILCATTRS_H
  32
  33 /****s* silccore/SilcAttributesAPI/SilcAttributePayload
  34  *
  35  * NAME
  36  *
  37  *    typedef struct SilcAttributePayloadStruct *SilcAttributePayload;
  38  *
  39  * DESCRIPTION
  40  *
  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.
  45  *
  46  ***/
  47 typedef struct SilcAttributePayloadStruct *SilcAttributePayload;
  48
  49 /****d* silccore/SilcAttributesAPI/SilcAttribute
  50  *
  51  * NAME
  52  *
  53  *    typedef SilcUInt8 SilcAttribute;
  54  *
  55  * DESCRIPTION
  56  *
  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.
  61  *
  62  * SOURCE
  63  */
  64 typedef SilcUInt8 SilcAttribute;
  65
  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   /* SilcMime */
  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  /* SilcMime */
  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 */
  85 #define SILC_ATTRIBUTE_USER_ICON              16  /* SilcMime */
  86 /***/
  87
  88 /* Maximum length of attribute request packet */
  89 #define SILC_ATTRIBUTE_MAX_REQUEST_LEN (4 * 255)
  90
  91 /****d* silccore/SilcAttributesAPI/SilcAttributeFlags
  92  *
  93  * NAME
  94  *
  95  *    typedef SilcUInt8 SilcAttributeFlags;
  96  *
  97  * DESCRIPTION
  98  *
  99  *    Attribute Payload flags defined by the specification.
 100  *
 101  * SOURCE
 102  */
 103 typedef SilcUInt8 SilcAttributeFlags;
 104
 105 /* All defined flags */
 106 #define SILC_ATTRIBUTE_FLAG_NONE          0x00    /* No flags */
 107 #define SILC_ATTRIBUTE_FLAG_INVALID       0x01    /* Invalid attribute */
 108 #define SILC_ATTRIBUTE_FLAG_VALID         0x02    /* Valid attribute */
 109 /***/
 110
 111 /****d* silccore/SilcAttributesAPI/SilcAttributeMood
 112  *
 113  * NAME
 114  *
 115  *    typedef enum { ... } SilcAttributeMood;
 116  *
 117  * DESCRIPTION
 118  *
 119  *    The user mood indicators defined by the specification.  This is
 120  *    bit mask.
 121  *
 122  * SOURCE
 123  */
 124 typedef enum {
 125   SILC_ATTRIBUTE_MOOD_NORMAL      = 0x00000000,   /* normal mood */
 126   SILC_ATTRIBUTE_MOOD_HAPPY       = 0x00000001,   /* user feel happy */
 127   SILC_ATTRIBUTE_MOOD_SAD         = 0x00000002,   /* user feel sad */
 128   SILC_ATTRIBUTE_MOOD_ANGRY       = 0x00000004,   /* user feel angry */
 129   SILC_ATTRIBUTE_MOOD_JEALOUS     = 0x00000008,   /* user feel jealous */
 130   SILC_ATTRIBUTE_MOOD_ASHAMED     = 0x00000010,   /* user feel ashamed */
 131   SILC_ATTRIBUTE_MOOD_INVINCIBLE  = 0x00000020,   /* user feel invincible */
 132   SILC_ATTRIBUTE_MOOD_INLOVE      = 0x00000040,   /* user feel in love */
 133   SILC_ATTRIBUTE_MOOD_SLEEPY      = 0x00000080,   /* user feel sleepy */
 134   SILC_ATTRIBUTE_MOOD_BORED       = 0x00000100,   /* user feel bored */
 135   SILC_ATTRIBUTE_MOOD_EXCITED     = 0x00000200,   /* user feel exited */
 136   SILC_ATTRIBUTE_MOOD_ANXIOUS     = 0x00000400,   /* user feel anxious */
 137 } SilcAttributeMood;
 138 /***/
 139
 140 /****d* silccore/SilcAttributesAPI/SilcAttributeContact
 141  *
 142  * NAME
 143  *
 144  *    typedef enum { ... } SilcAttributeContact;
 145  *
 146  * DESCRIPTION
 147  *
 148  *    The defined preferred contact methods defined by the specification.
 149  *    This is bit mask.
 150  *
 151  * SOURCE
 152  */
 153 typedef enum {
 154   SILC_ATTRIBUTE_CONTACT_NONE    = 0x00000000,    /* no specific method */
 155   SILC_ATTRIBUTE_CONTACT_EMAIL   = 0x00000001,    /* email preferred */
 156   SILC_ATTRIBUTE_CONTACT_CALL    = 0x00000002,    /* phone call preferred */
 157   SILC_ATTRIBUTE_CONTACT_PAGE    = 0x00000004,    /* "paging" preferred */
 158   SILC_ATTRIBUTE_CONTACT_SMS     = 0x00000008,    /* SMS preferred */
 159   SILC_ATTRIBUTE_CONTACT_MMS     = 0x00000010,    /* MMS preferred */
 160   SILC_ATTRIBUTE_CONTACT_CHAT    = 0x00000020,    /* chatting preferred */
 161   SILC_ATTRIBUTE_CONTACT_VIDEO   = 0x00000040,    /* video conferencing */
 162 } SilcAttributeContact;
 163 /***/
 164
 165 /****d* silccore/SilcAttributesAPI/SilcAttributeDevice
 166  *
 167  * NAME
 168  *
 169  *    typedef enum { ... } SilcAttributeDevice;
 170  *
 171  * DESCRIPTION
 172  *
 173  *    The defined device types defined by the specification.
 174  *
 175  * SOURCE
 176  */
 177 typedef enum {
 178   SILC_ATTRIBUTE_DEVICE_COMPUTER      = 0,        /* device is computer */
 179   SILC_ATTRIBUTE_DEVICE_MOBILE_PHONE  = 1,        /* device is mobile phone */
 180   SILC_ATTRIBUTE_DEVICE_PDA           = 2,        /* device is PDA */
 181   SILC_ATTRIBUTE_DEVICE_TERMINAL      = 3,        /* device is terminal */
 182 } SilcAttributeDevice;
 183 /***/
 184
 185 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_alloc
 186  *
 187  * SYNOPSIS
 188  *
 189  *    SilcAttributesPayload
 190  *    silc_attribute_payload_alloc(SilcAttribute attribute,
 191  *                                 SilcAttributeFlags flags,
 192  *                                 void *object,
 193  *                                 SilcUInt32 object_size);
 194  *
 195  * DESCRIPTION
 196  *
 197  *    Allocates and encodes the attribute indicated by `attribute' and
 198  *    returns pointer to the attribute.
 199  *
 200  *    The `object' must always be the same data type as defined with
 201  *    SilcAttribute (see the comments) for all attributes.
 202  *
 203  ***/
 204 SilcAttributePayload silc_attribute_payload_alloc(SilcAttribute attribute,
 205                                                   SilcAttributeFlags flags,
 206                                                   void *object,
 207                                                   SilcUInt32 object_size);
 208
 209 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_parse
 210  *
 211  * SYNOPSIS
 212  *
 213  *    SilcDList
 214  *    silc_attribute_payload_parse(const unsigned char *payload,
 215  *                                 SilcUInt32 payload_len);
 216  *
 217  * DESCRIPTION
 218  *
 219  *    Parses list of Attribute payloads returning list of payloads.
 220  *    One entry in the returned list is SilcAttributesPayload.  You
 221  *    can produce such a list with silc_attribute_payload_encode
 222  *    function.
 223  *
 224  ***/
 225 SilcDList silc_attribute_payload_parse(const unsigned char *payload,
 226                                        SilcUInt32 payload_len);
 227
 228 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_encode
 229  *
 230  * SYNOPSIS
 231  *
 232  *    SilcBuffer silc_attribute_payload_encode(SilcBuffer attrs,
 233  *                                             SilcAttribute attribute,
 234  *                                             SilcAttributeFlags flags,
 235  *                                             void *object,
 236  *                                             SilcUInt32 object_size);
 237  *
 238  * DESCRIPTION
 239  *
 240  *    Encodes one attribute payload into the `attrs' buffer and returns
 241  *    pointer to the buffer, which may be different in case the buffer
 242  *    was reallocated.  If `attrs' is NULL for first attribute this
 243  *    allocates the buffer and returns it.  This can be called multiple
 244  *    times to add multiple attributes to the `attrs' buffer.  The `flags'
 245  *    indicates the validity of the added attribute.  Returns NULL on
 246  *    error.
 247  *
 248  *    The `object' must always be the same data type as defined with
 249  *    SilcAttribute (see the comments) for all attributes.
 250  *
 251  ***/
 252 SilcBuffer silc_attribute_payload_encode(SilcBuffer attrs,
 253                                          SilcAttribute attribute,
 254                                          SilcAttributeFlags flags,
 255                                          void *object,
 256                                          SilcUInt32 object_size);
 257
 258 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_encode_data
 259  *
 260  * SYNOPSIS
 261  *
 262  *    SilcBuffer
 263  *    silc_attribute_payload_encode_data(SilcBuffer attrs,
 264  *                                       SilcAttribute attribute,
 265  *                                       SilcAttributeFlags flags,
 266  *                                       const unsigned char *data,
 267  *                                       SilcUInt32 data_len);
 268  *
 269  * DESCRIPTION
 270  *
 271  *    Same function as silc_attribute_payload_encode except the attribute
 272  *    is already encoded into `data' of `data_len' bytes in length.
 273  *    Encodes the attribute into the `attrs' buffer and returns pointer
 274  *    to the buffer, which may be different in case the buffer was
 275  *    reallocated.  If `attrs' is NULL for first attribute this allocates
 276  *    the buffer and returns it.  Returns NULL on error.
 277  *
 278  ***/
 279 SilcBuffer silc_attribute_payload_encode_data(SilcBuffer attrs,
 280                                               SilcAttribute attribute,
 281                                               SilcAttributeFlags flags,
 282                                               const unsigned char *data,
 283                                               SilcUInt32 data_len);
 284
 285 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_free
 286  *
 287  * SYNOPSIS
 288  *
 289  *    void silc_attribute_payload_free(SilcAttributePayload payload);
 290  *
 291  * DESCRIPTION
 292  *
 293  *    Frees the Attribute Payload and all data in it.
 294  *
 295  ***/
 296 void silc_attribute_payload_free(SilcAttributePayload payload);
 297
 298 /****f* silccore/SilcAttributesAPI/silc_attribute_payload_list_free
 299  *
 300  * SYNOPSIS
 301  *
 302  *    void silc_attribute_payload_list_free(SilcDList list);
 303  *
 304  * DESCRIPTION
 305  *
 306  *    Frees list of Attribute Payloads and all data in them.
 307  *
 308  ***/
 309 void silc_attribute_payload_list_free(SilcDList list);
 310
 311 /****f* silccore/SilcAttributesAPI/silc_attribute_get_attribute
 312  *
 313  * SYNOPSIS
 314  *
 315  *    SilcAttribute silc_attribute_get_attribute(SilcAttributePayload payload);
 316  *
 317  * DESCRIPTION
 318  *
 319  *    Return the attribute type from the payload indicated by `payload'.
 320  *
 321  ***/
 322 SilcAttribute silc_attribute_get_attribute(SilcAttributePayload payload);
 323
 324 /****f* silccore/SilcAttributesAPI/silc_attribute_get_flags
 325  *
 326  * SYNOPSIS
 327  *
 328  *    SilcAttributeFlags
 329  *    silc_attribute_get_flags(SilcAttributePayload payload);
 330  *
 331  * DESCRIPTION
 332  *
 333  *    Return the attribute flags from the payload indicated by `payload'.
 334  *
 335  ***/
 336 SilcAttributeFlags silc_attribute_get_flags(SilcAttributePayload payload);
 337
 338 /****f* silccore/SilcAttributesAPI/silc_attribute_get_data
 339  *
 340  * SYNOPSIS
 341  *
 342  *    const unsigned char *
 343  *    silc_attribute_get_data(SilcAttributePayload payload,
 344  *                            SilcUInt32 *data_len);
 345  *
 346  * DESCRIPTION
 347  *
 348  *    Returns the attribute data from the payload indicated by the `payload'
 349  *    The caller must not free the returned data pointer.
 350  *
 351  ***/
 352 const unsigned char *silc_attribute_get_data(SilcAttributePayload payload,
 353                                              SilcUInt32 *data_len);
 354
 355 /****f* silccore/SilcAttributesAPI/silc_attribute_get_verify_data
 356  *
 357  * SYNOPSIS
 358  *
 359  *    unsigned char *
 360  *    silc_attribute_get_verify_data(SilcDList attrs,
 361  *                                   SilcBool server_verification,
 362  *                                   SilcUInt32 *data_len);
 363  *
 364  * DESCRIPTION
 365  *
 366  *    Constructs the data to be verified with the sender's digital
 367  *    signature and sender's public key.  This allocates the data from
 368  *    the list of attribute payloads and returns the buffer.  The caller
 369  *    must free it.  If `server_verification' is FALSE then data is
 370  *    constructed for user's digital signature verification, if it is
 371  *    TRUE then it is constructed for server's digital signature
 372  *    verification.
 373  *
 374  ***/
 375 unsigned char *silc_attribute_get_verify_data(SilcDList attrs,
 376                                               SilcBool server_verification,
 377                                               SilcUInt32 *data_len);
 378
 379 /* Object structures */
 380
 381 /****s* silccore/SilcAttributesAPI/SilcAttributeObjService
 382  *
 383  * NAME
 384  *
 385  *    typedef struct { ... } SilcAttributeObjService;
 386  *
 387  * DESCRIPTION
 388  *
 389  *    SILC_ATTRIBUTE_SERVICE type object structure.
 390  *
 391  * SOURCE
 392  */
 393 typedef struct SilcAttributeObjServiceStruct {
 394   SilcUInt32 port;              /* IANA specified service port */
 395   SilcUInt32 idle;              /* Idle time in the service */
 396   char signon[64];              /* Signon date and time (UTC) */
 397   char address[256];            /* service address */
 398   SilcBool status;              /* online status (TRUE present in service) */
 399 } SilcAttributeObjService;
 400 /***/
 401
 402 /****s* silccore/SilcAttributesAPI/SilcAttributeObjGeo
 403  *
 404  * NAME
 405  *
 406  *    typedef struct { ... } SilcAttributeObjGeo;
 407  *
 408  * DESCRIPTION
 409  *
 410  *    SILC_ATTRIBUTE_GEOLOCATION type object.  The caller must free the
 411  *    strings inside the structure.
 412  *
 413  * SOURCE
 414  */
 415 typedef struct SilcAttributeObjGeoStruct {
 416   char *longitude;              /* Longitude */
 417   char *latitude;               /* Latitude */
 418   char *altitude;               /* Altitude */
 419   char *accuracy;               /* Accuracy in meters */
 420 } SilcAttributeObjGeo;
 421 /***/
 422
 423 /****s* silccore/SilcAttributesAPI/SilcAttributeObjDevice
 424  *
 425  * NAME
 426  *
 427  *    typedef struct { ... } SilcAttributeObjDevice;
 428  *
 429  * DESCRIPTION
 430  *
 431  *    SILC_ATTRIBUTE_DEVICE_INFO type object.  The caller must free the
 432  *    strings inside the structure.
 433  *
 434  * SOURCE
 435  */
 436 typedef struct SilcAttributeObjDeviceStruct {
 437   SilcAttributeDevice type;     /* device type */
 438   char *manufacturer;           /* manufacturer of the device */
 439   char *version;                /* device version string */
 440   char *model;                  /* device model string */
 441   char *language;               /* device language (ISO 639-2/T) */
 442 } SilcAttributeObjDevice;
 443 /***/
 444
 445 /****s* silccore/SilcAttributesAPI/SilcAttributeObjPk
 446  *
 447  * NAME
 448  *
 449  *    typedef struct { ... } SilcAttributeObjPk;
 450  *
 451  * DESCRIPTION
 452  *
 453  *    Data type for public key, certificate or digital signatures.  The
 454  *    caller must free the data inside the structure.  The 'type' is one
 455  *    of following: "silc-rsa", "silc-dss, "ssh-rsa", "ssh-dss",
 456  *    "pgp-sign-rsa", "pgp-sign-dss", "x509v3-sign-rsa", "x509v3-sign-dss".
 457  *    See the draft-riikonen-precense-attrs draft for more detailed
 458  *    information.  The 'type' is NULL when this structure includes a
 459  *    digital signature.
 460  *
 461  *    In SILC, at least the "silc-rsa" must be supported.  In this case
 462  *    the key is normal SILC Public key.  To verify a signature with the
 463  *    SILC Public key, construct the signature data with the
 464  *    silc_attribute_get_verify_data and verify the signature with
 465  *    for example silc_pkcs_verify_with_hash function.  The public key
 466  *    to the verification is the `data' and `data_len', and can be decoded
 467  *    with silc_pkcs_public_key_decode function.
 468  *
 469  * SOURCE
 470  */
 471 typedef struct SilcAttributeObjPkStruct {
 472   char *type;                   /* public key/certificate type, NULL
 473                                    when contains digital signature. */
 474   unsigned char *data;          /* public key/cert/signature data. The
 475                                    encoding depends of the `type'. */
 476   SilcUInt32 data_len;          /* data length */
 477 } SilcAttributeObjPk;
 478 /***/
 479
 480 /****f* silccore/SilcAttributesAPI/silc_attribute_get_object
 481  *
 482  * SYNOPSIS
 483  *
 484  *    SilcBool silc_attribute_get_object(SilcAttributePayload payload,
 485  *                                       void *object,
 486  *                                       SilcUInt32 object_size);
 487  *
 488  * DESCRIPTION
 489  *
 490  *    Returns the already parsed attribute object from the payload
 491  *    indicated by `payload'.  Copies the data into the `object' which
 492  *    must be sent as argument (and must be of correct type and size).
 493  *    The `object_size' indicates the size of the `*object' sent.
 494  *    Returns TRUE if the `attribute' attribute was found and FALSE
 495  *    if such attribute is not present in the `payload', or the `object_size'
 496  *    is not sufficient.  See the definition of SilcAttribute for the
 497  *    list of attributes and the required object types for attributes.
 498  *    You can use silc_attribute_get_attribute to get the SilcAttribute
 499  *    type from the `payload'.
 500  *
 501  * EXAMPLE
 502  *
 503  *    SilcAttributeObjDevice dev;
 504  *
 505  *    ...
 506  *    case SILC_ATTRIBUTE_DEVICE_INFO:
 507  *    memset(&dev, 0, sizeof(dev));
 508  *    if (!silc_attribute_get_object(payload, (void *)&dev, sizeof(dev)))
 509  *      error();
 510  *
 511  *    case SILC_ATTRIBUTE_USER_ICON:
 512  *    mime = silc_mime_alloc();
 513  *    if (!silc_attribute_get_object(payload, (void *)mime, sizeof(*mime)))
 514  *      error();
 515  *    ...
 516  *
 517  ***/
 518 SilcBool silc_attribute_get_object(SilcAttributePayload payload,
 519                                    void *object, SilcUInt32 object_size);
 520
 521 #endif /* SILCATTRS_H */