[or-cvs] More complete docs for crypto.c; factor out string partitio...
Nick Mathewson
nickm at seul.org
Thu Oct 7 20:58:55 UTC 2004
Update of /home/or/cvsroot/src/common
In directory moria.mit.edu:/tmp/cvs-serv18243/src/common
Modified Files:
crypto.c util.c util.h
Log Message:
More complete docs for crypto.c; factor out string partitioning code
Index: crypto.c
===================================================================
RCS file: /home/or/cvsroot/src/common/crypto.c,v
retrieving revision 1.106
retrieving revision 1.107
diff -u -d -r1.106 -r1.107
--- crypto.c 7 Oct 2004 03:11:41 -0000 1.106
+++ crypto.c 7 Oct 2004 20:58:52 -0000 1.107
@@ -142,7 +142,7 @@
}
}
-/** Initialize the crypto library.
+/** Initialize the crypto library. Return 0 on success, -1 on failure.
*/
int crypto_global_init()
{
@@ -153,7 +153,7 @@
return 0;
}
-/** Uninitialize the crypto library.
+/** Uninitialize the crypto library. Return 0 on success, -1 on failure.
*/
int crypto_global_cleanup()
{
@@ -318,6 +318,7 @@
}
/** Read a PEM-encoded private key from the string <b>s</b> into <b>env</b>.
+ * Return 0 on success, -1 on failure.
*/
static int crypto_pk_read_private_key_from_string(crypto_pk_env_t *env,
const char *s)
@@ -502,10 +503,9 @@
*/
crypto_pk_env_t *crypto_pk_DER64_decode_public_key(const char *in)
{
- char buf1[PK_BYTES*2 + PK_BYTES/64 + 2];
+ char partitioned[PK_BYTES*2 + 16];
char buf[PK_BYTES*2];
int len;
- int i;
tor_assert(in);
len = strlen(in);
@@ -514,11 +514,11 @@
}
/* base64_decode doesn't work unless we insert linebreaks every 64
* characters. how dumb. */
- for(i=0;i*64<len;i+=1) {
- strncpy(buf1+(64+1)*i, in+64*i, 64);
- strcpy(buf1+(64+1)*i + 64, "\n");
- }
- len = base64_decode(buf, sizeof(buf), buf1, strlen(buf1));
+ if (tor_strpartition(partitioned, sizeof(partitioned), in, "\n", 64))
+ return NULL;
+ if (strlcat(partitioned, "\n",sizeof(partitioned))>=sizeof(partitioned))
+ return NULL;
+ len = base64_decode(buf, sizeof(buf), partitioned, strlen(partitioned));
if (len<0) {
log_fn(LOG_WARN,"Error base-64 decoding key");
return NULL;
@@ -567,7 +567,7 @@
return RSA_size(env->key);
}
-/** Increase the reference count of <b>env</b>.
+/** Increase the reference count of <b>env</b>, and return it.
*/
crypto_pk_env_t *crypto_pk_dup_key(crypto_pk_env_t *env) {
tor_assert(env && env->key);
@@ -874,6 +874,7 @@
/** Given a private or public key <b>pk</b>, put a SHA1 hash of the
* public key into <b>digest_out</b> (must have DIGEST_LEN bytes of space).
+ * Return 0 on success, -1 on failure.
*/
int crypto_pk_get_digest(crypto_pk_env_t *pk, char *digest_out)
{
@@ -900,7 +901,7 @@
/** Given a private or public key <b>pk</b>, put a fingerprint of the
* public key into <b>fp_out</b> (must have at least FINGERPRINT_LEN+1 bytes of
- * space).
+ * space). Return 0 on success, -1 on failure.
*
* Fingerprints are computed as the SHA1 digest of the ASN.1 encoding
* of the public key, converted to hexadecimal, in upper case, with a
@@ -911,29 +912,17 @@
int
crypto_pk_get_fingerprint(crypto_pk_env_t *pk, char *fp_out, int add_space)
{
- unsigned char *bufp;
unsigned char digest[DIGEST_LEN];
- unsigned char buf[FINGERPRINT_LEN+1];
- int i;
+ unsigned char hexdigest[HEX_DIGEST_LEN+1];
if (crypto_pk_get_digest(pk, digest)) {
return -1;
}
- bufp = buf;
- for (i = 0; i < DIGEST_LEN; ++i) {
- sprintf(bufp,"%02X",digest[i]);
- bufp += 2;
- if (add_space) {
- if (i%2 && i != 19) {
- *bufp++ = ' ';
- }
- }
- }
- *bufp = '\0';
+ base16_encode(hexdigest,sizeof(hexdigest),digest,DIGEST_LEN);
if (add_space) {
- tor_assert(strlen(buf) == FINGERPRINT_LEN);
- tor_assert(crypto_pk_check_fingerprint_syntax(buf));
+ tor_strpartition(fp_out, FINGERPRINT_LEN+1, hexdigest, " ", 4);
+ } else {
+ strcpy(fp_out, hexdigest);
}
- strcpy(fp_out, buf);
return 0;
}
@@ -968,6 +957,7 @@
/** Set the symmetric key for the cipher in <b>env</b> to the first
* CIPHER_KEY_LEN bytes of <b>key</b>. Does not initialize the cipher.
+ * Return 0 on success, -1 on failure.
*/
int crypto_cipher_set_key(crypto_cipher_env_t *env, const unsigned char *key)
{
@@ -988,7 +978,8 @@
return env->key;
}
-/** Initialize the cipher in <b>env</b> for encryption.
+/** Initialize the cipher in <b>env</b> for encryption. Return 0 on
+ * success, -1 on failure.
*/
int crypto_cipher_encrypt_init_cipher(crypto_cipher_env_t *env)
{
@@ -998,7 +989,8 @@
return 0;
}
-/** Initialize the cipher in <b>env</b> for decryption.
+/** Initialize the cipher in <b>env</b> for decryption. Return 0 on
+ * success, -1 on failure.
*/
int crypto_cipher_decrypt_init_cipher(crypto_cipher_env_t *env)
{
@@ -1033,6 +1025,7 @@
}
/** Move the position of the cipher stream backwards by <b>delta</b> bytes.
+ * Return 0 on suuccess, -1 on failure.
*/
int
crypto_cipher_rewind(crypto_cipher_env_t *env, long delta)
@@ -1041,6 +1034,7 @@
}
/** Move the position of the cipher stream forwards by <b>delta</b> bytes.
+ * Return 0 on suuccess, -1 on failure.
*/
int
crypto_cipher_advance(crypto_cipher_env_t *env, long delta)
@@ -1053,6 +1047,7 @@
/** Compute the SHA1 digest of <b>len</b> bytes in data stored in
* <b>m</b>. Write the DIGEST_LEN byte result into <b>digest</b>.
+ * Return 0 on suuccess, -1 on failure.
*/
int crypto_digest(const unsigned char *m, int len, unsigned char *digest)
{
@@ -1269,9 +1264,10 @@
#undef MIN
#define MIN(a,b) ((a)<(b)?(a):(b))
/** Given a DH key exchange object, and our peer's value of g^y (as a
- * <b>pubkey_len</b> byte value in <b>pubkey</b>) generate
+ * <b>pubkey_len</b>-byte value in <b>pubkey</b>) generate
* <b>secret_bytes_out</b> bytes of shared key material and write them
- * to <b>secret_out</b>.
+ * to <b>secret_out</b>. Return the number of bytes generated on suuccess,
+ * or -1 on failure.
*
* (We generate key material by computing
* SHA1( g^xy || "\x00" ) || SHA1( g^xy || "\x01" ) || ...
@@ -1324,7 +1320,7 @@
/* random numbers */
/** Seed OpenSSL's random number generator with DIGEST_LEN bytes from the
- * operating system.
+ * operating system. Return 0 on suuccess, -1 on failure.
*/
int crypto_seed_rng()
{
Index: util.c
===================================================================
RCS file: /home/or/cvsroot/src/common/util.c,v
retrieving revision 1.136
retrieving revision 1.137
diff -u -d -r1.136 -r1.137
--- util.c 6 Oct 2004 13:26:37 -0000 1.136
+++ util.c 7 Oct 2004 20:58:53 -0000 1.137
@@ -216,6 +216,31 @@
return read-s;
}
+/** Set the <b>dest_len</b>-byte buffer <b>buf</b> to contain the
+ * string <b>s</b>, with the string <b>insert</b> inserted after every
+ * <b>n</b> characters. Return 0 on success, -1 on failure.
+ */
+int tor_strpartition(char *dest, size_t dest_len,
+ const char *s, const char *insert, size_t n)
+{
+ tor_assert(s && insert && n > 0);
+ int len_in, len_out, len_ins;
+ len_in = strlen(s);
+ len_ins = strlen(insert);
+ len_out = len_in + (len_in/n)*len_ins;
+ if (dest_len < len_out+1)
+ return -1;
+ while(len_in) {
+ strncpy(dest, s, n);
+ len_in -= n;
+ if (len_in < 0) break;
+ strcpy(dest+n, insert);
+ s += n;
+ dest += n+len_ins;
+ }
+ return 0;
+}
+
#ifndef UNALIGNED_INT_ACCESS_OK
/**
* Read a 16-bit value beginning at <b>cp</b>. Equaivalent to
Index: util.h
===================================================================
RCS file: /home/or/cvsroot/src/common/util.h,v
retrieving revision 1.90
retrieving revision 1.91
diff -u -d -r1.90 -r1.91
--- util.h 7 Oct 2004 03:11:41 -0000 1.90
+++ util.h 7 Oct 2004 20:58:53 -0000 1.91
@@ -88,6 +88,9 @@
void tor_strlower(char *s);
int strcmpstart(const char *s1, const char *s2);
int tor_strstrip(char *s, const char *strip);
+int tor_strpartition(char *dest, size_t dest_len,
+ const char *s, const char *insert, size_t n);
+
/* Some platforms segfault when you try to access a multi-byte type
* that isn't aligned to a word boundary. The macros and/or functions
More information about the tor-commits
mailing list