Changeset 611

Timestamp:

09/03/08 09:37:32

Author:

rachel

Message:

--

Files:

• openpgpsdk/trunk/src/lib/create.c (modified) (8 diffs)
• openpgpsdk/trunk/src/lib/keyring.c (modified) (20 diffs)
• openpgpsdk/trunk/src/lib/memory.c (modified) (2 diffs)
• openpgpsdk/trunk/src/lib/readerwriter.c (modified) (2 diffs)
• openpgpsdk/trunk/src/lib/util.c (modified) (3 diffs)

openpgpsdk/trunk/src/lib/create.c

@@ -397 +397 @@
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    {
-    ops_boolean_t rtn;
@@ -406 +433 @@
-
-    // public key
-
+data
-    if (rtn!=ops_true)
-        return rtn;
@@ -413 +440 @@
-
-    // user ids and corresponding signatures
-
-
-
+data
+
+data
-
-        rtn=ops_write_struct_user_id(uid, info);
@@ -423 +450 @@
-
-        // find signature for this packet if it exists
-
+data
-            {
-
+data
-            if (!strcmp((char *)sig->userid->user_id, (char *)uid->user_id))
-                {
@@ -448 +475 @@
-    }
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    {
-    ops_boolean_t rtn;
@@ -457 +513 @@
-
-    // public key
-
+data
-    if (rtn!=ops_true)
-        return rtn;
@@ -464 +520 @@
-
-    // user ids and corresponding signatures
-
-
-
+data
+
+data
-
-        rtn=ops_write_struct_user_id(uid, info);
@@ -474 +530 @@
-
-        // find signature for this packet if it exists
-
+data
-            {
-
+data
-            if (!strcmp((char *)sig->userid->user_id, (char *)uid->user_id))
-                {

openpgpsdk/trunk/src/lib/keyring.c

@@ -46 +46 @@
-#include <openpgpsdk/final.h>
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    {
-    unsigned n;
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+data
+data
+data
+data
+data
+
+data
+data
+data
+data
+data
+
+data
+data
-    else
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-const ops_public_key_t *
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    { return data->type != OPS_PTAG_CT_PUBLIC_KEY; }
+
+/**
+ \ingroup HighLevel_Key
+
+ \brief Returns the secret key in the given keydata.
+
+ \note This is not a copy, do not free it after use.
+
+ \note This returns a const. If you need to be able to write to this pointer, use ops_get_writable_secret_key_from_data
+*/
-
-const ops_secret_key_t *
@@ -89 +139 @@
-    return &data->key.skey;
-    }
+
+/**
+ \ingroup HighLevel_Key
+
+  \brief Returns the secret key in the given keydata.
+
+  \note This is not a copy, do not free it after use.
+
+  \note If you do not need to be able to modify this key, there is an equivalent read-only function ops_get_secret_key_from_data.
+*/
-
-ops_secret_key_t *
@@ -214 +274 @@
-    }
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-            return ops_true;
-        }
-
-
+data
+data
-            return ops_true;
-        }
@@ -229 +299 @@
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    return &keyring->keys[index]; 
-    }
@@ -373 +470 @@
-    }
-
-ops_keydata_t *ops_keydata_new(void)
-    { return ops_mallocz(sizeof(ops_keydata_t)); }
-
-void ops_keydata_init(ops_keydata_t* keydata, const ops_content_tag_t type)
-    {
@@ -384 +478 @@
-    }
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-    Example Usage:
-    \code
@@ -414 +497 @@
-*/
-
-/**
-    @defgroup StdKeyringFind Keyfind Find Operations
-    \ingroup StdKeyring
-    Find Key or its info within keyring
-
-    Example Usage:
-    \code
-
-    // definition of variables
-    ops_keyring_t keyring;
-    unsigned char* keyid;
-    ops_key_data_t *key;
-
-    // Read keyring from file
-    ops_keyring_read_from_file(&keyring,"~/.gnupg/pubring.gpg");
-
-    // Search for keys
-
-    // - get Key ID from given userid
-    keyid=ops_keyring_find_keyid_by_userid (keyring, "user@domain.com")
-
-    // - now get key from Key ID
-    key=ops_keyring_find_key_by_id(keyring, keyid);
-
-    // do something with key
-    ...
-    
-    // Free memory alloc-ed in ops_keyring_read_from_file()
-    ops_keyring_free();
-    \endcode
- */
-
-static ops_parse_cb_return_t
-cb_keyring_read(const ops_parser_content_t *content_,
@@ -451 +502 @@
-
-/**
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-   \note Keyring struct must already exist.
-
@@ -466 +520 @@
-   \note If you call this twice on the same keyring struct, without calling
-   ops_keyring_free() between these calls, you will introduce a memory leak.
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-ops_boolean_t ops_keyring_read_from_file(ops_keyring_t *keyring, const ops_boolean_t armour, const char *filename)
-    {
@@ -472 +538 @@
-    int fd;
-    ops_boolean_t res = ops_true;
-
-    //memset(keyring,'\0',sizeof *keyring);
-
-    pinfo=ops_parse_info_new();
@@ -511 +575 @@
-    ops_print_errors(ops_parse_info_get_errors(pinfo));
-
+    if (armour)
+        ops_reader_pop_dearmour(pinfo);
+
-    close(fd);
-
@@ -519 +586 @@
-
-/**
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-   \note Keyring struct must already exist.
-
@@ -534 +604 @@
-   \note If you call this twice on the same keyring struct, without calling
-   ops_keyring_free() between these calls, you will introduce a memory leak.
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-    ops_parse_info_t *pinfo=NULL;
-    ops_boolean_t res = ops_true;
-
-    // \todo need to free memory first?
-    //memset(keyring,'\0',sizeof *keyring);
-
-    pinfo=ops_parse_info_new();
-    ops_parse_options(pinfo,OPS_PTAG_SS_ALL,OPS_PARSE_PARSED);
@@ -550 +625 @@
-    ops_setup_memory_read(&pinfo, mem, NULL, cb_keyring_read);
-
-
+
+
+
+
-
-    if ( ops_parse_and_accumulate(keyring,pinfo) == 0 ) 
@@ -562 +640 @@
-    ops_print_errors(ops_parse_info_get_errors(pinfo));
-
-
+
+
-
-    // don't call teardown_memory_read because memory was passed in
@@ -571 +650 @@
-
-/**
-StdKeyringFile
+HighLevel_KeyringMemory
- 
-Frees alloc-ed memory
+\brief Frees keyring's contents (but not keyring itself)
- 
-   \param keyring Keyring whose data is to be freed
@@ -588 +667 @@
-
-/**
-Std
-
-
+HighLevel_
+
+\brief 
-
-   \param keyring Keyring to be searched
-   \param keyid ID of required key
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-*/
-const ops_keydata_t *
@@ -616 +708 @@
-
-/**
-Std
-
-
+HighLevel_
+
+\brief 
-
-   \param keyring Keyring to be searched
-   \param userid User ID of required key
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-*/
-const ops_keydata_t *
@@ -650 +754 @@
-
-/**
-Std
-
-List keys in keyring
+HighLevel_
+
+\brief Prints all keys in keyring to stdout.
-
-   \param keyring Keyring to use
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-*/
-
-void
-
-
+
-    {
-    int n;
@@ -672 +790 @@
-        for(i=0; i<key->nuids; i++)
-            {
-
-
-
-
-
-
+
-                ops_print_secret_keydata(key);
-            else

openpgpsdk/trunk/src/lib/memory.c

@@ -131 +131 @@
-    }
-
+/**
+   \ingroup HighLevel_Misc
+   \brief Create a new zeroed ops_memory_t
+   \return Pointer to new ops_memory_t
+   \note Free using ops_memory_free() after use.
+*/
+
-ops_memory_t *ops_memory_new()
-    { return ops_mallocz(sizeof(ops_memory_t)); }
+
+/**
+   \ingroup HighLevel_Misc
+   \brief Free memory
+   \param mem Memory to be freed
+*/
-
-void ops_memory_free(ops_memory_t *mem)
@@ -140 +153 @@
-    }
-
+/**
+   \ingroup HighLevel_Misc
+   \brief Get length of data stored in ops_memory_t struct
+   \return Number of bytes in data
+*/
-size_t ops_memory_get_length(const ops_memory_t *mem)
-    { return mem->length; }
-
+/**
+   \ingroup HighLevel_Misc
+   \brief Get data stored in ops_memory_t struct
+   \return Pointer to data
+*/
-void *ops_memory_get_data(ops_memory_t *mem)
-    { return mem->buf; }

openpgpsdk/trunk/src/lib/readerwriter.c

@@ -252 +252 @@
-    }
-
+/**
+ \ingroup Core_Callbacks
+
+\brief Callback to get secret key, decrypting if necessary.
+
+@verbatim
+ This callback does the following:
+ * finds the session key in the keyring
+ * gets a passphrase if required
+ * decrypts the secret key, if necessary
+ * sets the secret_key in the content struct
+@endverbatim
+*/
+
-ops_parse_cb_return_t
-callback_cmd_get_secret_key(const ops_parser_content_t *content_,ops_parse_cb_info_t *cbinfo)
@@ -267 +281 @@
-    case OPS_PARSER_CMD_GET_SECRET_KEY:
-        cbinfo->cryptinfo.keydata=ops_keyring_find_key_by_id(cbinfo->cryptinfo.keyring,content->get_secret_key.pk_session_key->key_id);
-key_is
+is_key
-            return 0;
-

openpgpsdk/trunk/src/lib/util.c

@@ -82 +82 @@
-
-/**
-
-
-
-
+
+
- */
-
@@ -94 +92 @@
-
-/**
-
+
+
- *
- * Close down OpenPGP:SDK, release any resources under the control of
@@ -152 +151 @@
-    }
-
+/**
+   \ingroup HighLevel_Misc
+   \brief mallocs and zeros memory
+   \param n Number of bytes to be alloc-ed.
+   \return Pointer to new memory.
+   \note Should be freed after use with free().
+*/
-void *ops_mallocz(size_t n)
-    {