Add rxgk_crypto_rfc3961.c 65/10565/24
authorBen Kaduk <kaduk@mit.edu>
Mon, 9 Dec 2013 20:26:06 +0000 (15:26 -0500)
committerBenjamin Kaduk <kaduk@mit.edu>
Fri, 14 Sep 2018 12:33:33 +0000 (08:33 -0400)
rxgk wrappers around an external crypto library, in this case, our
in-tree rfc3961 library.  Primitives for encryption/decryption and
MIC/VerifyMIC, ways to generate and free rxgk_key objects, etc..

Change-Id: I7525086043baf54f5c3019b3f5ab3495760c4236
Reviewed-on: https://gerrit.openafs.org/10565
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: Benjamin Kaduk <kaduk@mit.edu>

Makefile.in
src/rxgk/Makefile.in
src/rxgk/liboafs_rxgk.la.sym
src/rxgk/rxgk.h
src/rxgk/rxgk_crypto_rfc3961.c [new file with mode: 0644]
src/rxgk/rxgk_private.h

index 7a54018..0fbb118 100644 (file)
@@ -217,7 +217,7 @@ afs: config export comerr afs_depinstall
 sys: cmd comerr afs hcrypto rx rxstat fsint sys_depinstall
        +${COMPILE_PART1} sys ${COMPILE_PART2}
 
-rxgk: cmd comerr hcrypto rx rxgk_depinstall
+rxgk: cmd comerr hcrypto rfc3961 rx rxgk_depinstall
        +set -x; \
        if test "@BUILD_RXGK@" = "yes"; then \
                ${COMPILE_PART1} rxgk ${COMPILE_PART2} ; \
index cdbadb7..de539f0 100644 (file)
@@ -7,11 +7,12 @@ INCLS=        ${TOP_INCDIR}/rx/rx.h ${TOP_INCDIR}/rx/rxgk.h ${TOP_INCDIR}/rx/rxgk_errs.
        ${TOP_INCDIR}/rx/rxgk_int.h
 
 LT_objs = rxgk_client.lo rxgk_server.lo rxgk_errs.lo rxgk_int.cs.lo \
-       rxgk_int.xdr.lo rxgk_int.ss.lo rxgk_procs.lo
+       rxgk_int.xdr.lo rxgk_int.ss.lo rxgk_procs.lo rxgk_crypto_rfc3961.lo
 
 LT_deps =   $(top_builddir)/src/opr/liboafs_opr.la \
            $(top_builddir)/src/comerr/liboafs_comerr.la \
-           $(top_builddir)/src/rx/liboafs_rx.la
+           $(top_builddir)/src/rx/liboafs_rx.la \
+           $(top_builddir)/src/crypto/rfc3961/liboafs_rfc3961.la
 
 LT_libs =   # gssapi will go here
 
index 5ef5e44..7a10e3c 100644 (file)
@@ -2,3 +2,15 @@ RXGK_CombineTokens
 RXGK_GSSNegotiate
 rxgk_NewClientSecurityObject
 rxgk_NewServerSecurityObject
+rxgk_check_mic_in_key
+rxgk_cipher_expansion
+rxgk_copy_key
+rxgk_decrypt_in_key
+rxgk_derive_tk
+rxgk_encrypt_in_key
+rxgk_make_key
+rxgk_mic_in_key
+rxgk_mic_length
+rxgk_nonce
+rxgk_random_key
+rxgk_release_key
index 930e69a..064025b 100644 (file)
@@ -63,7 +63,7 @@ static_inline rxgkTime RXGK_NOW(void)
 
 /* rxgk_key is an opaque type to wrap our RFC3961 implementation's concept
  * of a key.  It has (at least) the keyblock and length, and enctype. */
-typedef void * rxgk_key;
+typedef struct rxgk_key_s * rxgk_key;
 
 typedef afs_int32 (*rxgk_getkey_func)(void *rock, afs_int32 *kvno,
                                      afs_int32 *enctype, rxgk_key *key);
@@ -77,4 +77,25 @@ struct rx_securityClass *rxgk_NewClientSecurityObject(RXGK_Level level,
                                                      RXGK_Data *token,
                                                      afsUUID *uuid);
 
+/* rxgk_crypto_IMPL.c (currently rfc3961 is the only IMPL) */
+afs_int32 rxgk_make_key(rxgk_key *key_out, void *raw_key, afs_uint32 length,
+                       afs_int32 enctype) AFS_NONNULL();
+afs_int32 rxgk_copy_key(rxgk_key key_in, rxgk_key *key_out) AFS_NONNULL();
+afs_int32 rxgk_random_key(afs_int32 *enctype, rxgk_key *key_out) AFS_NONNULL();
+void rxgk_release_key(rxgk_key *key) AFS_NONNULL();
+afs_int32 rxgk_mic_length(rxgk_key key, size_t *out) AFS_NONNULL();
+afs_int32 rxgk_mic_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+                         RXGK_Data *out) AFS_NONNULL();
+afs_int32 rxgk_check_mic_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+                               RXGK_Data *mic) AFS_NONNULL();
+afs_int32 rxgk_encrypt_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+                             RXGK_Data *out) AFS_NONNULL();
+afs_int32 rxgk_decrypt_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+                             RXGK_Data *out) AFS_NONNULL();
+afs_int32 rxgk_derive_tk(rxgk_key *tk, rxgk_key k0, afs_uint32 epoch,
+                        afs_uint32 cid, rxgkTime start_time,
+                        afs_uint32 key_number) AFS_NONNULL();
+afs_int32 rxgk_cipher_expansion(rxgk_key k0, afs_uint32 *len_out) AFS_NONNULL();
+afs_int32 rxgk_nonce(RXGK_Data *nonce, afs_uint32 len) AFS_NONNULL();
+
 #endif /* OPENAFS_RXGK_H */
diff --git a/src/rxgk/rxgk_crypto_rfc3961.c b/src/rxgk/rxgk_crypto_rfc3961.c
new file mode 100644 (file)
index 0000000..5485ed5
--- /dev/null
@@ -0,0 +1,784 @@
+/* rxgk/rxgk_crypto_rfc3961.c - Wrappers for RFC3961 crypto used in RXGK. */
+/*
+ * Copyright (C) 2013, 2014 by the Massachusetts Institute of Technology.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in
+ *   the documentation and/or other materials provided with the
+ *   distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+ * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+ * OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/**
+ * @file
+ * Wrappers for the RFC3961 crypto routines used by RXGK, and
+ * helpers.  This implementation uses the in-tree rfc3961 library, but
+ * we do not expose those types in our interface so as to be
+ * compatible with other backends in the future.  It should be possible
+ * to backend to an out-of-tree krb5 library or the kernel's crypto
+ * framework using this API.
+ *
+ * Public functions in this file should return RXGK error codes, because
+ * error codes from these functions can end up on the wire.  This will
+ * entail converting from any krb5 error codes that are used internally.
+ */
+
+#include <afsconfig.h>
+#include <afs/param.h>
+#include <afs/stds.h>
+
+#ifdef KERNEL
+# include "afs/sysincludes.h"
+# include "afsincludes.h"
+#else
+# include <errno.h>
+#endif
+
+#include <rx/rx.h>
+#include <rx/rxgk.h>
+#include <afs/rfc3961.h>
+#include <afs/opr.h>
+
+#include "rxgk_private.h"
+
+/*
+ * This is what an rxgk_key really is, but it's a 'struct rxgk_key_s' to consumers:
+ * typedef struct rxgk_keyblock * rxgk_key;
+ */
+struct rxgk_keyblock {
+    /* A krb5 context for this key, only to be used for initialization and
+     * destruction of the key. Do not use this for actually using the key for
+     * crypto operations; we are supposed to avoid accessing it in multiple
+     * threads at the same time. */
+    krb5_context init_ctx;
+    krb5_keyblock key;
+};
+
+struct rxgk_key_s {
+    struct rxgk_keyblock keyblock;
+};
+
+/* Convenience macro; reduces the diff if an MIT krb5 backend is made. */
+#define deref_keyblock_enctype(k)      krb5_keyblock_get_enctype(k)
+
+/* Convenience functions to convert between the opaque rxgk_key type and our
+ * internal rxgk_keyblock struct. */
+static_inline struct rxgk_keyblock *
+key2keyblock(rxgk_key key)
+{
+    return &key->keyblock;
+}
+
+static_inline rxgk_key
+keyblock2key(struct rxgk_keyblock *keyblock)
+{
+    return (rxgk_key)keyblock;
+}
+
+/**
+ * Convert krb5 error code to RXGK error code.  Don't let the krb5 codes escape.
+ */
+static_inline afs_int32
+ktor(afs_int32 err)
+{
+
+    if (err >= ERROR_TABLE_BASE_RXGK && err < (ERROR_TABLE_BASE_RXGK + 256))
+       return err;
+    switch (err) {
+       case 0:
+           return 0;
+       default:
+           return RXGK_INCONSISTENCY;
+    }
+}
+
+/**
+ * Convert a krb5 enctype to a krb5 checksum type.
+ *
+ * Each enctype has a mandatory (to implement) checksum type, which can be
+ * chosen when computing a checksum by passing 0 for the type parameter.
+ * However, we must separately compute the length of a checksum on a message in
+ * order to extract the checksum from a packet at RXGK_LEVEL_AUTH, and Heimdal
+ * krb5 does not expose a way to get the mandatory checksum type for a given
+ * enctype.  So, we get to do it ourselves.
+ *
+ * @return -1 on failure, otherwise the checksum type.
+ */
+static_inline afs_int32
+etoc(afs_int32 etype)
+{
+    switch(etype) {
+       case ETYPE_DES_CBC_CRC:
+           return CKSUMTYPE_RSA_MD5_DES;
+       case ETYPE_DES_CBC_MD4:
+           return CKSUMTYPE_RSA_MD4_DES;
+       case ETYPE_DES_CBC_MD5:
+           return CKSUMTYPE_RSA_MD5_DES;
+       case ETYPE_DES3_CBC_SHA1:
+           return CKSUMTYPE_HMAC_SHA1_DES3;
+       case ETYPE_ARCFOUR_MD4:
+           return CKSUMTYPE_HMAC_MD5_ENC;
+       case ETYPE_AES128_CTS_HMAC_SHA1_96:
+           return CKSUMTYPE_HMAC_SHA1_96_AES_128;
+       case ETYPE_AES256_CTS_HMAC_SHA1_96:
+           return CKSUMTYPE_HMAC_SHA1_96_AES_256;
+       default:
+           return -1;
+    }
+}
+
+/**
+ * Get the number of octets of input needed for a key of the given etype,
+ *
+ * @return -1 on error, or the number of octets of input needed on success.
+ */
+ssize_t
+rxgk_etype_to_len(int etype)
+{
+    krb5_context ctx;
+    krb5_error_code code;
+    size_t bits;
+
+    code = krb5_init_context(&ctx);
+    if (code != 0)
+       return -1;
+    code = krb5_enctype_keybits(ctx, etype, &bits);
+    krb5_free_context(ctx);
+    if (code != 0)
+       return -1;
+    return (bits + 7) / 8;
+}
+
+/**
+ * Take a raw key from some external source and produce an rxgk_key from it.
+ *
+ * The raw_key and length are not an RXGK_Data because in some cases they will
+ * come from a gss_buffer and there's no real need to do the conversion.
+ * The caller must use rxgk_release_key to deallocate memory allocated for the
+ * new rxgk_key.
+ *
+ * This routine checks whether the length of the supplied key data matches the
+ * key generation seed length for the requested enctype, in which case the RFC
+ * 3961 random_to_key operation is performed, or if it is the actual (output)
+ * key length, in which case the key data is used as-is.
+ *
+ * @param key_out      the returned rxgk_key.
+ * @param raw_key      a pointer to the octet stream of the key input data.
+ * @param length       the length of raw_key (in octets).
+ * @param enctype      the RFC 3961 enctype of the key being constructed.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_make_key(rxgk_key *key_out, void *raw_key, afs_uint32 length,
+             afs_int32 enctype)
+{
+    struct rxgk_keyblock *new_key = NULL;
+    krb5_error_code ret;
+    size_t full_length;
+    ssize_t input_length;
+
+    /* Must initialize before we return. */
+    *key_out = NULL;
+
+    new_key = rxi_Alloc(sizeof(*new_key));
+    if (new_key == NULL) {
+       ret = RXGK_INCONSISTENCY;
+       goto done;
+    }
+    ret = krb5_init_context(&new_key->init_ctx);
+    if (ret != 0)
+       goto done;
+    ret = krb5_enctype_keysize(new_key->init_ctx, enctype, &full_length);
+    if (ret != 0)
+       goto done;
+    input_length = rxgk_etype_to_len(enctype);
+    if (input_length < 0) {
+       ret = RXGK_INCONSISTENCY;
+       goto done;
+    }
+    if (length == full_length) {
+       /* free with krb5_free_keyblock_contents + rxi_Free */
+       ret = krb5_keyblock_init(new_key->init_ctx, enctype, raw_key, length,
+                                 &new_key->key);
+    } else if (length == input_length) {
+       /* free with krb5_free_keyblock_contents + rxi_Free */
+       ret = krb5_random_to_key(new_key->init_ctx, enctype, raw_key, length,
+                                 &new_key->key);
+    } else {
+       ret = RXGK_BADETYPE;
+    }
+    if (ret != 0)
+       goto done;
+    *key_out = keyblock2key(new_key);
+ done:
+    if (ret != 0 && new_key != NULL) {
+       krb5_free_context(new_key->init_ctx);
+       rxi_Free(new_key, sizeof(*new_key));
+    }
+    return ktor(ret);
+}
+
+/**
+ * Copy a given key.
+ *
+ * The caller must use rxgk_release_key to deallocate the memory allocated
+ * for the new rxgk_key.
+ *
+ * @param[in] key_in   The key to be copied.
+ * @param[out] key_out A copy of key_in.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_copy_key(rxgk_key key_in, rxgk_key *key_out)
+{
+    struct rxgk_keyblock *keyblock;
+
+    keyblock = key2keyblock(key_in);
+    return rxgk_make_key(key_out, keyblock->key.keyvalue.data,
+                        keyblock->key.keyvalue.length, keyblock->key.keytype);
+}
+
+/**
+ * Generate a random key.
+ *
+ * The caller must use rxgk_release_key to deallocate the memory allocated
+ * for the new rxgk_key.
+ *
+ * @param[inout] enctype  The RFC 3961 enctype of the key to be generated. If
+ *                        0, set this to a default enctype, and use that
+ *                        enctype for the generated key.
+ * @param[out] key_out The random rxgk key.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_random_key(afs_int32 *enctype, rxgk_key *key_out)
+{
+    void *buf;
+    krb5_error_code ret;
+    ssize_t len;
+
+    buf = NULL;
+    *key_out = NULL;
+
+    if (*enctype == 0)
+        *enctype = ETYPE_AES128_CTS_HMAC_SHA1_96;
+
+    len = rxgk_etype_to_len(*enctype);
+    if (len < 0)
+       return RXGK_INCONSISTENCY;
+    buf = rxi_Alloc(len);
+    if (buf == NULL)
+       return RXGK_INCONSISTENCY;
+    krb5_generate_random_block(buf, (size_t)len);
+    ret = rxgk_make_key(key_out, buf, len, *enctype);
+    rxi_Free(buf, len);
+    return ret;
+}
+
+/**
+ * Release the storage underlying an rxgk key
+ *
+ * Call into the underlying library to release any storage allocated for
+ * the rxgk_key, and null out the key pointer.
+ */
+void
+rxgk_release_key(rxgk_key *key)
+{
+    struct rxgk_keyblock *keyblock;
+
+    if (*key == NULL)
+       return;
+    keyblock = key2keyblock(*key);
+
+    krb5_free_keyblock_contents(keyblock->init_ctx, &keyblock->key);
+    krb5_free_context(keyblock->init_ctx);
+    rxi_Free(keyblock, sizeof(*keyblock));
+    *key = NULL;
+}
+
+/**
+ * Determine the length of a checksum (MIC) using the specified key.
+ *
+ * @param[in] key      The rxgk_key being queried.
+ * @param[out] out     The length of a checksum made using key.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_mic_length(rxgk_key key, size_t *out)
+{
+    krb5_context ctx = NULL;
+    krb5_cksumtype cstype;
+    krb5_enctype enctype;
+    krb5_error_code ret;
+    struct rxgk_keyblock *keyblock = key2keyblock(key);
+    size_t len;
+
+    *out = 0;
+
+    ret = krb5_init_context(&ctx);
+    if (ret != 0)
+        goto done;
+
+    enctype = deref_keyblock_enctype(&keyblock->key);
+    cstype = etoc(enctype);
+    if (cstype == -1) {
+       ret = RXGK_BADETYPE;
+       goto done;
+    }
+    ret = krb5_checksumsize(ctx, cstype, &len);
+    if (ret != 0)
+       goto done;
+    *out = len;
+
+ done:
+    krb5_free_context(ctx);
+    return ktor(ret);
+}
+
+/**
+ * Obtain the RFC 3961 Message Integrity Check of a buffer
+ *
+ * Call into the RFC 3961 encryption framework to obtain a Message Integrity
+ * Check of a buffer using the specified key and key usage.  It is assumed
+ * that the rxgk_key structure includes the enctype information needed to
+ * determine which crypto routine to call.
+ *
+ * The output buffer is allocated with rx_opaque_populate() and must be freed
+ * by the caller (with rx_opaque_freeContents()).
+ *
+ * @param[in] key      The key used to key the MIC.
+ * @param[in] usage    The key usage value to use (from rxgk_int.h).
+ * @param[in] in       The input buffer to be MICd.
+ * @param[out] out     The MIC.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_mic_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+               RXGK_Data *out)
+{
+    krb5_context ctx = NULL;
+    Checksum cksum;
+    krb5_cksumtype cstype;
+    krb5_crypto crypto = NULL;
+    krb5_enctype enctype;
+    krb5_error_code ret;
+    struct rxgk_keyblock *keyblock = key2keyblock(key);
+    size_t len;
+
+    memset(&cksum, 0, sizeof(cksum));
+    memset(out, 0, sizeof(*out));
+
+    ret = krb5_init_context(&ctx);
+    if (ret != 0)
+        goto done;
+
+    enctype = deref_keyblock_enctype(&keyblock->key);
+    cstype = etoc(enctype);
+    if (cstype == -1) {
+       ret = RXGK_BADETYPE;
+       goto done;
+    }
+    ret = krb5_checksumsize(ctx, cstype, &len);
+    if (ret != 0)
+       goto done;
+    ret = krb5_crypto_init(ctx, &keyblock->key, enctype, &crypto);
+    if (ret != 0)
+       goto done;
+    ret = krb5_create_checksum(ctx, crypto, usage, cstype, in->val,
+                              in->len, &cksum);
+    if (ret != 0)
+       goto done;
+    /* sanity check */
+    if (len != cksum.checksum.length) {
+       ret = RXGK_INCONSISTENCY;
+       goto done;
+    }
+    ret = rx_opaque_populate(out, cksum.checksum.data, len);
+
+ done:
+    free_Checksum(&cksum);
+    if (crypto != NULL)
+       krb5_crypto_destroy(ctx, crypto);
+    krb5_free_context(ctx);
+    return ktor(ret);
+}
+
+/**
+ * Verify the RFC 3961 Message Integrity Check on a message
+ *
+ * Call into the RFC 3961 encryption framework to verify a message integrity
+ * check on a message, using the specified key with the specified key usage.
+ * It is assumed that the rxgk_key structure includes the enctype information
+ * needed to determine which particular crypto routine to call.
+ *
+ * @param[in] key      The key keying the checksum.
+ * @param[in] usage    The key usage for the checksum.
+ * @param[in] in       The buffer which was checksummed.
+ * @param[in] mic      The MIC to be verified.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_check_mic_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+                     RXGK_Data *mic)
+{
+    krb5_context ctx = NULL;
+    Checksum cksum;
+    krb5_crypto crypto = NULL;
+    krb5_enctype enctype;
+    krb5_error_code ret;
+    struct rxgk_keyblock *keyblock = key2keyblock(key);
+
+    memset(&cksum, 0, sizeof(cksum));
+
+    ret = krb5_init_context(&ctx);
+    if (ret != 0)
+        goto done;
+
+    enctype = deref_keyblock_enctype(&keyblock->key);
+    cksum.cksumtype = etoc(enctype);
+    ret = krb5_crypto_init(ctx, &keyblock->key, enctype, &crypto);
+    if (ret != 0)
+       goto done;
+    cksum.checksum.data = mic->val;
+    cksum.checksum.length = mic->len;
+    ret = krb5_verify_checksum(ctx, crypto, usage, in->val, in->len,
+                              &cksum);
+    /* Un-alias the storage to avoid a double-free. */
+    cksum.checksum.data = NULL;
+    cksum.checksum.length = 0;
+    if (ret != 0) {
+       ret = RXGK_SEALED_INCON;
+    }
+
+ done:
+    free_Checksum(&cksum);
+    if (crypto != NULL)
+       krb5_crypto_destroy(ctx, crypto);
+    krb5_free_context(ctx);
+    return ktor(ret);
+}
+
+/**
+ * Encrypt a buffer in a key using the RFC 3961 framework
+ *
+ * Call into the RFC 3961 encryption framework to encrypt a buffer with
+ * specified key and key usage.  It is assumed that the rxgk_key structure
+ * includes the enctype information needed to determine which particular
+ * crypto routine to call.
+ *
+ * The output buffer is allocated with rx_opaque_populate() and must be freed
+ * by the caller (with rx_opaque_freeContents()).
+ *
+ * @param[in] key      The key used to encrypt the message.
+ * @param[in] usage    The key usage for the encryption.
+ * @param[in] in       The buffer being encrypted.
+ * @param[out] out     The encrypted form of the message.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_encrypt_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+                   RXGK_Data *out)
+{
+    krb5_context ctx = NULL;
+    krb5_crypto crypto = NULL;
+    krb5_data kd_out;
+    krb5_enctype enctype;
+    krb5_error_code ret;
+    struct rxgk_keyblock *keyblock = key2keyblock(key);
+
+    memset(&kd_out, 0, sizeof(kd_out));
+    memset(out, 0, sizeof(*out));
+
+    ret = krb5_init_context(&ctx);
+    if (ret != 0)
+        goto done;
+
+    enctype = deref_keyblock_enctype(&keyblock->key);
+    ret = krb5_crypto_init(ctx, &keyblock->key, enctype, &crypto);
+    if (ret != 0)
+       goto done;
+    ret = krb5_encrypt(ctx, crypto, usage, in->val, in->len, &kd_out);
+    if (ret != 0)
+       goto done;
+    ret = rx_opaque_populate(out, kd_out.data, kd_out.length);
+
+ done:
+    if (crypto != NULL)
+       krb5_crypto_destroy(ctx, crypto);
+    krb5_data_free(&kd_out);
+    krb5_free_context(ctx);
+    return ktor(ret);
+}
+
+/**
+ * Decrypt a buffer using a given key in the RFC 3961 framework
+ *
+ * Call into the RFC 3961 encryption framework to decrypt a buffer with the
+ * specified key with the specified key usage.  It is assumed that the
+ * rxgk_key structure includes the enctype information needed to determine
+ * which particular crypto routine to call.
+ *
+ * The output buffer is allocated with rx_opaque_populate() and must be freed
+ * by the caller (with rx_opaque_freeContents()).
+ *
+ * @param[in] key      The key to use for the decryption.
+ * @param[in] usage    The key usage used for the encryption.
+ * @param[in] in       The encrypted message.
+ * @param[out] out     The decrypted message.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_decrypt_in_key(rxgk_key key, afs_int32 usage, RXGK_Data *in,
+                   RXGK_Data *out)
+{
+    krb5_context ctx = NULL;
+    krb5_crypto crypto = NULL;
+    krb5_data kd_out;
+    krb5_enctype enctype;
+    krb5_error_code ret;
+    struct rxgk_keyblock *keyblock = key2keyblock(key);
+
+    memset(out, 0, sizeof(*out));
+    memset(&kd_out, 0, sizeof(kd_out));
+
+    ret = krb5_init_context(&ctx);
+    if (ret != 0)
+        goto done;
+
+    enctype = deref_keyblock_enctype(&keyblock->key);
+    ret = krb5_crypto_init(ctx, &keyblock->key, enctype, &crypto);
+    if (ret != 0)
+       goto done;
+    ret = krb5_decrypt(ctx, crypto, usage, in->val, in->len, &kd_out);
+    if (ret != 0) {
+        ret = RXGK_SEALED_INCON;
+       goto done;
+    }
+    ret = rx_opaque_populate(out, kd_out.data, kd_out.length);
+
+ done:
+    if (crypto != NULL)
+       krb5_crypto_destroy(ctx, crypto);
+    krb5_data_free(&kd_out);
+    krb5_free_context(ctx);
+    return ktor(ret);
+}
+
+/*
+ * Helper for derive_tk.
+ * Assumes the caller has already allocated space in 'out'.
+ */
+static afs_int32
+PRFplus(krb5_data *out, krb5_enctype enctype, rxgk_key k0,
+       void *seed, size_t seed_len)
+{
+    krb5_context ctx = NULL;
+    krb5_crypto crypto = NULL;
+    krb5_data prf_in, prf_out;
+    krb5_error_code ret;
+    struct rxgk_keyblock *keyblock = key2keyblock(k0);
+    unsigned char *pre_key = NULL;
+    size_t block_len;
+    size_t desired_len = out->length;
+    afs_uint32 n_iter, iterations, dummy;
+
+    memset(&prf_in, 0, sizeof(prf_in));
+    memset(&prf_out, 0, sizeof(prf_out));
+
+    ret = krb5_init_context(&ctx);
+    if (ret != 0)
+        goto done;
+
+    ret = krb5_crypto_init(ctx, &keyblock->key, enctype, &crypto);
+    if (ret != 0)
+       goto done;
+    prf_in.length = sizeof(n_iter) + seed_len;
+    prf_in.data = rxi_Alloc(prf_in.length);
+    if (prf_in.data == NULL) {
+       ret = RXGK_INCONSISTENCY;
+       goto done;
+    }
+    memcpy((unsigned char *)prf_in.data + sizeof(n_iter), seed, seed_len);
+    ret = krb5_crypto_prf_length(ctx, enctype, &block_len);
+    if (ret != 0)
+       goto done;
+    /* We need desired_len/block_len iterations, rounded up. */
+    iterations = (desired_len + block_len - 1) / block_len;
+    pre_key = rxi_Alloc(iterations * block_len);
+    if (pre_key == NULL) {
+       ret = RXGK_INCONSISTENCY;
+       goto done;
+    }
+
+    for (n_iter = 1; n_iter <= iterations; ++n_iter) {
+       dummy = htonl(n_iter);
+       memcpy(prf_in.data, &dummy, sizeof(dummy));
+       krb5_data_free(&prf_out);
+       ret = krb5_crypto_prf(ctx, crypto, &prf_in, &prf_out);
+       if (ret != 0)
+           goto done;
+       memcpy(pre_key + (n_iter - 1) * block_len, prf_out.data, block_len);
+    }
+    memcpy(out->data, pre_key, desired_len);
+    out->length = desired_len;
+
+ done:
+    if (crypto != NULL)
+       krb5_crypto_destroy(ctx, crypto);
+    krb5_data_free(&prf_out);
+    krb5_free_context(ctx);
+    rxi_Free(prf_in.data, prf_in.length);
+    if (pre_key != NULL)
+       rxi_Free(pre_key, iterations * block_len);
+    return ktor(ret);
+}
+
+struct seed_data {
+    afs_uint32 epoch;
+    afs_uint32 cid;
+    afs_uint32 time_hi;
+    afs_uint32 time_lo;
+    afs_uint32 key_number;
+} __attribute__((packed));
+
+/* Our seed_data buffer that we feed into the PRF+ algorithm to generate our
+ * transport key had better be exactly 20 bytes large, to match the format of
+ * the seed data in the rxgk spec. */
+#define RXGK_SEED_DATA_SIZE 20
+
+/**
+ * Compute a transport key tk given a master key k0
+ *
+ * Given a connection master key k0, derive a transport key tk from the master
+ * key and connection parameters.
+ *
+ * TK = random-to-key(PRF+(K0, L, epoch || cid || start_time || key_number))
+ * using the RFC4402 PRF+, i.e., the ordinal of the application of the
+ * pseudo-random() function is stored in a 32-bit field, not an 8-bit field
+ * as in RFC6112.
+ *
+ * @param[out] tk              The derived transport key.
+ * @param[in] k0               The token master key.
+ * @param[in] epoch            The rx epoch of the connection.
+ * @param[in] cid              The rx connection id of the connection.
+ * @param[in] start_time       The start_time of the connection.
+ * @param[in] key_number       The current key number of the connection.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_derive_tk(rxgk_key *tk, rxgk_key k0, afs_uint32 epoch, afs_uint32 cid,
+              rxgkTime start_time, afs_uint32 key_number)
+{
+    krb5_enctype enctype;
+    krb5_data pre_key;
+    struct rxgk_keyblock *keyblock = key2keyblock(k0);
+    struct seed_data seed;
+    ssize_t ell;
+    afs_int32 ret;
+
+    memset(&pre_key, 0, sizeof(pre_key));
+    memset(&seed, 0, sizeof(seed));
+
+    opr_StaticAssert(sizeof(seed) == RXGK_SEED_DATA_SIZE);
+    enctype = deref_keyblock_enctype(&keyblock->key);
+    ell = rxgk_etype_to_len(enctype);
+    if (ell < 0)
+       return RXGK_INCONSISTENCY;
+
+    seed.epoch = htonl(epoch);
+    seed.cid = htonl(cid);
+    seed.time_hi = htonl((afs_int32)(start_time / ((afs_int64)1 << 32)));
+    seed.time_lo = htonl((afs_uint32)(start_time & (afs_uint64)0xffffffffu));
+    seed.key_number = htonl(key_number);
+
+    pre_key.data = rxi_Alloc(ell);
+    if (pre_key.data == NULL) {
+       ret = RXGK_INCONSISTENCY;
+       goto done;
+    }
+    pre_key.length = ell;
+    ret = PRFplus(&pre_key, enctype, k0, &seed, sizeof(seed));
+    if (ret != 0)
+       goto done;
+
+    ret = rxgk_make_key(tk, pre_key.data, ell, enctype);
+    if (ret != 0)
+       goto done;
+
+ done:
+    rxi_Free(pre_key.data, ell);
+    return ret;
+}
+
+/**
+ * Determine the maximum ciphertext expansion for a given enctype.
+ *
+ * @param[in] k0       The rxgk key to be used.
+ * @param[out] len_out The maximum ciphertext expansion, in octets.
+ * @return rxgk error codes.
+ */
+afs_int32
+rxgk_cipher_expansion(rxgk_key k0, afs_uint32 *len_out)
+{
+    krb5_context ctx = NULL;
+    krb5_crypto crypto = NULL;
+    krb5_enctype enctype;
+    krb5_error_code ret;
+    struct rxgk_keyblock *keyblock = key2keyblock(k0);
+    size_t len;
+
+    *len_out = 0;
+
+    enctype = deref_keyblock_enctype(&keyblock->key);
+    ret = krb5_init_context(&ctx);
+    if (ret != 0)
+        goto done;
+    ret = krb5_crypto_init(ctx, &keyblock->key, enctype, &crypto);
+    if (ret != 0)
+       goto done;
+    len = krb5_crypto_overhead(ctx, crypto);
+    *len_out = len;
+
+ done:
+    if (crypto != NULL)
+       krb5_crypto_destroy(ctx, crypto);
+    krb5_free_context(ctx);
+    return ktor(ret);
+}
+
+/**
+ * Allocate and fill the buffer in nonce with len bytes of random data.
+ *
+ * @param[out] nonce   The buffer of random data.
+ * @param[in] len      The number of octets of random data to produce.
+ * @return rx error codes.
+ */
+afs_int32
+rxgk_nonce(RXGK_Data *nonce, afs_uint32 len)
+{
+    if (rx_opaque_alloc(nonce, len) != 0)
+       return RXGK_INCONSISTENCY;
+
+    krb5_generate_random_block(nonce->val, len);
+    return 0;
+}
index 05d434d..4597b73 100644 (file)
@@ -124,4 +124,7 @@ struct rxgk_cconn {
     struct rxgkStats stats;
 };
 
+/* rxgk_crypto_IMPL.c (currently rfc3961 is the only IMPL) */
+ssize_t rxgk_etype_to_len(int etype);
+
 #endif /* RXGK_PRIVATE_H */