More comments.
authorPekka Riikonen <priikone@silcnet.org>
Sat, 18 Oct 2003 20:31:06 +0000 (20:31 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Sat, 18 Oct 2003 20:31:06 +0000 (20:31 +0000)
lib/silcclient/silcclient.h
lib/silccore/silcattrs.h

index e73e7945097b7b2119c237f4ca10fa53ac43d38d..49b23729ac490bd79758dcdae2e0af32b5b76624 100644 (file)
@@ -2617,6 +2617,16 @@ const SilcHashTable silc_client_attributes_get(SilcClient client,
  *    You can give the returned buffer as argument to for example
  *    silc_client_get_client_by_id_resolve function.
  *
+ * EXAMPLE
+ *
+ *    Request all attributes
+ *    buffer = silc_client_attributes_request(0);
+ *
+ *    Request only the following attributes
+ *    buffer = silc_client_attributes_request(SILC_ATTRIBUTE_USER_INFO,
+ *                                            SILC_ATTRIBUTE_SERVICE,
+ *                                            SILC_ATTRIBUTE_MOOD, 0);
+ *
  ***/
 SilcBuffer silc_client_attributes_request(SilcAttribute attribute, ...);
 
index d8e724aebdab318b197e8e602d959686dd80c59b..2c578dbfda27d67cad736ebd8ed93a630cdaea8a 100644 (file)
@@ -469,7 +469,20 @@ typedef struct SilcAttributeObjDeviceStruct {
  * DESCRIPTION
  *
  *    Data type for public key, certificate or digital signatures.  The
- *    caller must free the data inside the structure.
+ *    caller must free the data inside the structure.  The 'type' is one
+ *    of following: "silc-rsa", "silc-dss, "ssh-rsa", "ssh-dss",
+ *    "pgp-sign-rsa", "pgp-sign-dss", "x509v3-sign-rsa", "x509v3-sign-dss".
+ *    See the draft-riikonen-precense-attrs draft for more detailed
+ *    information.  The 'type' is NULL when this structure includes a
+ *    digital signature.
+ *
+ *    In SILC, at least the "silc-rsa" must be supported.  In this case
+ *    the key is normal SILC Public key.  To verify a signature with the
+ *    SILC Public key, construct the signature data with the
+ *    silc_attribute_get_verify_data and verify the signature with
+ *    for example silc_pkcs_verify_with_hash function.  The public key
+ *    to the verification is the `data' and `data_len', and can be decoded
+ *    with silc_pkcs_public_key_decode function.
  *
  * SOURCE
  */