SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/sunrpc/gss_krb5.h

   1 /*
   2  *  linux/include/linux/sunrpc/gss_krb5_types.h
   3  *
   4  *  Adapted from MIT Kerberos 5-1.2.1 lib/include/krb5.h,
   5  *  lib/gssapi/krb5/gssapiP_krb5.h, and others
   6  *
   7  *  Copyright (c) 2000-2008 The Regents of the University of Michigan.
   8  *  All rights reserved.
   9  *
  10  *  Andy Adamson   <andros@umich.edu>
  11  *  Bruce Fields   <bfields@umich.edu>
  12  */
  13
  14 /*
  15  * Copyright 1995 by the Massachusetts Institute of Technology.
  16  * All Rights Reserved.
  17  *
  18  * Export of this software from the United States of America may
  19  *   require a specific license from the United States Government.
  20  *   It is the responsibility of any person or organization contemplating
  21  *   export to obtain such a license before exporting.
  22  *
  23  * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
  24  * distribute this software and its documentation for any purpose and
  25  * without fee is hereby granted, provided that the above copyright
  26  * notice appear in all copies and that both that copyright notice and
  27  * this permission notice appear in supporting documentation, and that
  28  * the name of M.I.T. not be used in advertising or publicity pertaining
  29  * to distribution of the software without specific, written prior
  30  * permission.  Furthermore if you modify this software you must label
  31  * your software as modified software and not distribute it in such a
  32  * fashion that it might be confused with the original M.I.T. software.
  33  * M.I.T. makes no representations about the suitability of
  34  * this software for any purpose.  It is provided "as is" without express
  35  * or implied warranty.
  36  *
  37  */
  38
  39 #include <linux/crypto.h>
  40 #include <linux/sunrpc/auth_gss.h>
  41 #include <linux/sunrpc/gss_err.h>
  42 #include <linux/sunrpc/gss_asn1.h>
  43
  44 /* Length of constant used in key derivation */
  45 #define GSS_KRB5_K5CLENGTH (5)
  46
  47 /* Maximum key length (in bytes) for the supported crypto algorithms*/
  48 #define GSS_KRB5_MAX_KEYLEN (32)
  49
  50 /* Maximum checksum function output for the supported crypto algorithms */
  51 #define GSS_KRB5_MAX_CKSUM_LEN  (20)
  52
  53 /* Maximum blocksize for the supported crypto algorithms */
  54 #define GSS_KRB5_MAX_BLOCKSIZE  (16)
  55
  56 struct gss_krb5_enctype {
  57         const u32               etype;          /* encryption (key) type */
  58         const u32               ctype;          /* checksum type */
  59         const char              *name;          /* "friendly" name */
  60         const char              *encrypt_name;  /* crypto encrypt name */
  61         const char              *cksum_name;    /* crypto checksum name */
  62         const u16               signalg;        /* signing algorithm */
  63         const u16               sealalg;        /* sealing algorithm */
  64         const u32               blocksize;      /* encryption blocksize */
  65         const u32               cksumlength;    /* checksum length */
  66         const u32               keyed_cksum;    /* is it a keyed cksum? */
  67         const u32               keybytes;       /* raw key len, in bytes */
  68         const u32               keylength;      /* final key len, in bytes */
  69         u32 (*encrypt) (struct crypto_blkcipher *tfm,
  70                         void *iv, void *in, void *out,
  71                         int length);            /* encryption function */
  72         u32 (*decrypt) (struct crypto_blkcipher *tfm,
  73                         void *iv, void *in, void *out,
  74                         int length);            /* decryption function */
  75         u32 (*mk_key) (struct gss_krb5_enctype *gk5e,
  76                        struct xdr_netobj *in,
  77                        struct xdr_netobj *out); /* complete key generation */
  78 };
  79
  80 struct krb5_ctx {
  81         int                     initiate; /* 1 = initiating, 0 = accepting */
  82         u32                     enctype;
  83         const struct gss_krb5_enctype *gk5e; /* enctype-specific info */
  84         struct crypto_blkcipher *enc;
  85         struct crypto_blkcipher *seq;
  86         u8                      cksum[GSS_KRB5_MAX_KEYLEN];
  87         s32                     endtime;
  88         u32                     seq_send;
  89         struct xdr_netobj       mech_used;
  90 };
  91
  92 extern spinlock_t krb5_seq_lock;
  93
  94 /* The length of the Kerberos GSS token header */
  95 #define GSS_KRB5_TOK_HDR_LEN    (16)
  96
  97 #define KG_TOK_MIC_MSG    0x0101
  98 #define KG_TOK_WRAP_MSG   0x0201
  99
 100 enum sgn_alg {
 101         SGN_ALG_DES_MAC_MD5 = 0x0000,
 102         SGN_ALG_MD2_5 = 0x0001,
 103         SGN_ALG_DES_MAC = 0x0002,
 104         SGN_ALG_3 = 0x0003,             /* not published */
 105         SGN_ALG_HMAC_MD5 = 0x0011,      /* microsoft w2k; no support */
 106         SGN_ALG_HMAC_SHA1_DES3_KD = 0x0004
 107 };
 108 enum seal_alg {
 109         SEAL_ALG_NONE = 0xffff,
 110         SEAL_ALG_DES = 0x0000,
 111         SEAL_ALG_1 = 0x0001,            /* not published */
 112         SEAL_ALG_MICROSOFT_RC4 = 0x0010,/* microsoft w2k; no support */
 113         SEAL_ALG_DES3KD = 0x0002
 114 };
 115
 116 #define CKSUMTYPE_CRC32                 0x0001
 117 #define CKSUMTYPE_RSA_MD4               0x0002
 118 #define CKSUMTYPE_RSA_MD4_DES           0x0003
 119 #define CKSUMTYPE_DESCBC                0x0004
 120 #define CKSUMTYPE_RSA_MD5               0x0007
 121 #define CKSUMTYPE_RSA_MD5_DES           0x0008
 122 #define CKSUMTYPE_NIST_SHA              0x0009
 123 #define CKSUMTYPE_HMAC_SHA1_DES3        0x000c
 124
 125 /* from gssapi_err_krb5.h */
 126 #define KG_CCACHE_NOMATCH                        (39756032L)
 127 #define KG_KEYTAB_NOMATCH                        (39756033L)
 128 #define KG_TGT_MISSING                           (39756034L)
 129 #define KG_NO_SUBKEY                             (39756035L)
 130 #define KG_CONTEXT_ESTABLISHED                   (39756036L)
 131 #define KG_BAD_SIGN_TYPE                         (39756037L)
 132 #define KG_BAD_LENGTH                            (39756038L)
 133 #define KG_CTX_INCOMPLETE                        (39756039L)
 134 #define KG_CONTEXT                               (39756040L)
 135 #define KG_CRED                                  (39756041L)
 136 #define KG_ENC_DESC                              (39756042L)
 137 #define KG_BAD_SEQ                               (39756043L)
 138 #define KG_EMPTY_CCACHE                          (39756044L)
 139 #define KG_NO_CTYPES                             (39756045L)
 140
 141 /* per Kerberos v5 protocol spec crypto types from the wire.
 142  * these get mapped to linux kernel crypto routines.
 143  */
 144 #define ENCTYPE_NULL            0x0000
 145 #define ENCTYPE_DES_CBC_CRC     0x0001  /* DES cbc mode with CRC-32 */
 146 #define ENCTYPE_DES_CBC_MD4     0x0002  /* DES cbc mode with RSA-MD4 */
 147 #define ENCTYPE_DES_CBC_MD5     0x0003  /* DES cbc mode with RSA-MD5 */
 148 #define ENCTYPE_DES_CBC_RAW     0x0004  /* DES cbc mode raw */
 149 /* XXX deprecated? */
 150 #define ENCTYPE_DES3_CBC_SHA    0x0005  /* DES-3 cbc mode with NIST-SHA */
 151 #define ENCTYPE_DES3_CBC_RAW    0x0006  /* DES-3 cbc mode raw */
 152 #define ENCTYPE_DES_HMAC_SHA1   0x0008
 153 #define ENCTYPE_DES3_CBC_SHA1   0x0010
 154 #define ENCTYPE_UNKNOWN         0x01ff
 155
 156 /*
 157  * Constants used for key derivation
 158  */
 159 /* for 3DES */
 160 #define KG_USAGE_SEAL (22)
 161 #define KG_USAGE_SIGN (23)
 162 #define KG_USAGE_SEQ  (24)
 163
 164 /* from rfc3961 */
 165 #define KEY_USAGE_SEED_CHECKSUM         (0x99)
 166 #define KEY_USAGE_SEED_ENCRYPTION       (0xAA)
 167 #define KEY_USAGE_SEED_INTEGRITY        (0x55)
 168
 169 /* from rfc4121 */
 170 #define KG_USAGE_ACCEPTOR_SEAL  (22)
 171 #define KG_USAGE_ACCEPTOR_SIGN  (23)
 172 #define KG_USAGE_INITIATOR_SEAL (24)
 173 #define KG_USAGE_INITIATOR_SIGN (25)
 174
 175 /*
 176  * This compile-time check verifies that we will not exceed the
 177  * slack space allotted by the client and server auth_gss code
 178  * before they call gss_wrap().
 179  */
 180 #define GSS_KRB5_MAX_SLACK_NEEDED \
 181         (GSS_KRB5_TOK_HDR_LEN     /* gss token header */         \
 182         + GSS_KRB5_MAX_CKSUM_LEN  /* gss token checksum */       \
 183         + GSS_KRB5_MAX_BLOCKSIZE  /* confounder */               \
 184         + GSS_KRB5_MAX_BLOCKSIZE  /* possible padding */         \
 185         + GSS_KRB5_TOK_HDR_LEN    /* encrypted hdr in v2 token */\
 186         + GSS_KRB5_MAX_CKSUM_LEN  /* encryption hmac */          \
 187         + 4 + 4                   /* RPC verifier */             \
 188         + GSS_KRB5_TOK_HDR_LEN                                   \
 189         + GSS_KRB5_MAX_CKSUM_LEN)
 190
 191 u32
 192 make_checksum(struct krb5_ctx *kctx, char *header, int hdrlen,
 193                 struct xdr_buf *body, int body_offset, u8 *cksumkey,
 194                 struct xdr_netobj *cksumout);
 195
 196 u32 gss_get_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
 197                 struct xdr_netobj *);
 198
 199 u32 gss_verify_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
 200                 struct xdr_netobj *);
 201
 202 u32
 203 gss_wrap_kerberos(struct gss_ctx *ctx_id, int offset,
 204                 struct xdr_buf *outbuf, struct page **pages);
 205
 206 u32
 207 gss_unwrap_kerberos(struct gss_ctx *ctx_id, int offset,
 208                 struct xdr_buf *buf);
 209
 210
 211 u32
 212 krb5_encrypt(struct crypto_blkcipher *key,
 213              void *iv, void *in, void *out, int length);
 214
 215 u32
 216 krb5_decrypt(struct crypto_blkcipher *key,
 217              void *iv, void *in, void *out, int length);
 218
 219 int
 220 gss_encrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *outbuf,
 221                     int offset, struct page **pages);
 222
 223 int
 224 gss_decrypt_xdr_buf(struct crypto_blkcipher *tfm, struct xdr_buf *inbuf,
 225                     int offset);
 226
 227 s32
 228 krb5_make_seq_num(struct crypto_blkcipher *key,
 229                 int direction,
 230                 u32 seqnum, unsigned char *cksum, unsigned char *buf);
 231
 232 s32
 233 krb5_get_seq_num(struct crypto_blkcipher *key,
 234                unsigned char *cksum,
 235                unsigned char *buf, int *direction, u32 *seqnum);
 236
 237 int
 238 xdr_extend_head(struct xdr_buf *buf, unsigned int base, unsigned int shiftlen);
 239
 240 u32
 241 krb5_derive_key(struct gss_krb5_enctype *gk5e,
 242                 const struct xdr_netobj *inkey,
 243                 struct xdr_netobj *outkey,
 244                 const struct xdr_netobj *in_constant);