LXR linux/include/linux/sunrpc/gss

   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 <crypto/skcipher.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
  56struct krb5_ctx;
  57
  58struct gss_krb5_enctype {
  59        const u32               etype;          /* encryption (key) type */
  60        const u32               ctype;          /* checksum type */
  61        const char              *name;          /* "friendly" name */
  62        const char              *encrypt_name;  /* crypto encrypt name */
  63        const char              *cksum_name;    /* crypto checksum name */
  64        const u16               signalg;        /* signing algorithm */
  65        const u16               sealalg;        /* sealing algorithm */
  66        const u32               blocksize;      /* encryption blocksize */
  67        const u32               conflen;        /* confounder length
  68                                                   (normally the same as
  69                                                   the blocksize) */
  70        const u32               cksumlength;    /* checksum length */
  71        const u32               keyed_cksum;    /* is it a keyed cksum? */
  72        const u32               keybytes;       /* raw key len, in bytes */
  73        const u32               keylength;      /* final key len, in bytes */
  74        u32 (*encrypt) (struct crypto_skcipher *tfm,
  75                        void *iv, void *in, void *out,
  76                        int length);            /* encryption function */
  77        u32 (*decrypt) (struct crypto_skcipher *tfm,
  78                        void *iv, void *in, void *out,
  79                        int length);            /* decryption function */
  80        u32 (*mk_key) (const struct gss_krb5_enctype *gk5e,
  81                       struct xdr_netobj *in,
  82                       struct xdr_netobj *out); /* complete key generation */
  83        u32 (*encrypt_v2) (struct krb5_ctx *kctx, u32 offset,
  84                           struct xdr_buf *buf,
  85                           struct page **pages); /* v2 encryption function */
  86        u32 (*decrypt_v2) (struct krb5_ctx *kctx, u32 offset,
  87                           struct xdr_buf *buf, u32 *headskip,
  88                           u32 *tailskip);      /* v2 decryption function */
  89};
  90
  91/* krb5_ctx flags definitions */
  92#define KRB5_CTX_FLAG_INITIATOR         0x00000001
  93#define KRB5_CTX_FLAG_CFX               0x00000002
  94#define KRB5_CTX_FLAG_ACCEPTOR_SUBKEY   0x00000004
  95
  96struct krb5_ctx {
  97        int                     initiate; /* 1 = initiating, 0 = accepting */
  98        u32                     enctype;
  99        u32                     flags;
 100        const struct gss_krb5_enctype *gk5e; /* enctype-specific info */
 101        struct crypto_skcipher  *enc;
 102        struct crypto_skcipher  *seq;
 103        struct crypto_skcipher *acceptor_enc;
 104        struct crypto_skcipher *initiator_enc;
 105        struct crypto_skcipher *acceptor_enc_aux;
 106        struct crypto_skcipher *initiator_enc_aux;
 107        u8                      Ksess[GSS_KRB5_MAX_KEYLEN]; /* session key */
 108        u8                      cksum[GSS_KRB5_MAX_KEYLEN];
 109        s32                     endtime;
 110        u32                     seq_send;
 111        u64                     seq_send64;
 112        struct xdr_netobj       mech_used;
 113        u8                      initiator_sign[GSS_KRB5_MAX_KEYLEN];
 114        u8                      acceptor_sign[GSS_KRB5_MAX_KEYLEN];
 115        u8                      initiator_seal[GSS_KRB5_MAX_KEYLEN];
 116        u8                      acceptor_seal[GSS_KRB5_MAX_KEYLEN];
 117        u8                      initiator_integ[GSS_KRB5_MAX_KEYLEN];
 118        u8                      acceptor_integ[GSS_KRB5_MAX_KEYLEN];
 119};
 120
 121extern spinlock_t krb5_seq_lock;
 122
 123/* The length of the Kerberos GSS token header */
 124#define GSS_KRB5_TOK_HDR_LEN    (16)
 125
 126#define KG_TOK_MIC_MSG    0x0101
 127#define KG_TOK_WRAP_MSG   0x0201
 128
 129#define KG2_TOK_INITIAL     0x0101
 130#define KG2_TOK_RESPONSE    0x0202
 131#define KG2_TOK_MIC         0x0404
 132#define KG2_TOK_WRAP        0x0504
 133
 134#define KG2_TOKEN_FLAG_SENTBYACCEPTOR   0x01
 135#define KG2_TOKEN_FLAG_SEALED           0x02
 136#define KG2_TOKEN_FLAG_ACCEPTORSUBKEY   0x04
 137
 138#define KG2_RESP_FLAG_ERROR             0x0001
 139#define KG2_RESP_FLAG_DELEG_OK          0x0002
 140
 141enum sgn_alg {
 142        SGN_ALG_DES_MAC_MD5 = 0x0000,
 143        SGN_ALG_MD2_5 = 0x0001,
 144        SGN_ALG_DES_MAC = 0x0002,
 145        SGN_ALG_3 = 0x0003,             /* not published */
 146        SGN_ALG_HMAC_MD5 = 0x0011,      /* microsoft w2k; no support */
 147        SGN_ALG_HMAC_SHA1_DES3_KD = 0x0004
 148};
 149enum seal_alg {
 150        SEAL_ALG_NONE = 0xffff,
 151        SEAL_ALG_DES = 0x0000,
 152        SEAL_ALG_1 = 0x0001,            /* not published */
 153        SEAL_ALG_MICROSOFT_RC4 = 0x0010,/* microsoft w2k; no support */
 154        SEAL_ALG_DES3KD = 0x0002
 155};
 156
 157#define CKSUMTYPE_CRC32                 0x0001
 158#define CKSUMTYPE_RSA_MD4               0x0002
 159#define CKSUMTYPE_RSA_MD4_DES           0x0003
 160#define CKSUMTYPE_DESCBC                0x0004
 161#define CKSUMTYPE_RSA_MD5               0x0007
 162#define CKSUMTYPE_RSA_MD5_DES           0x0008
 163#define CKSUMTYPE_NIST_SHA              0x0009
 164#define CKSUMTYPE_HMAC_SHA1_DES3        0x000c
 165#define CKSUMTYPE_HMAC_SHA1_96_AES128   0x000f
 166#define CKSUMTYPE_HMAC_SHA1_96_AES256   0x0010
 167#define CKSUMTYPE_HMAC_MD5_ARCFOUR      -138 /* Microsoft md5 hmac cksumtype */
 168
 169/* from gssapi_err_krb5.h */
 170#define KG_CCACHE_NOMATCH                        (39756032L)
 171#define KG_KEYTAB_NOMATCH                        (39756033L)
 172#define KG_TGT_MISSING                           (39756034L)
 173#define KG_NO_SUBKEY                             (39756035L)
 174#define KG_CONTEXT_ESTABLISHED                   (39756036L)
 175#define KG_BAD_SIGN_TYPE                         (39756037L)
 176#define KG_BAD_LENGTH                            (39756038L)
 177#define KG_CTX_INCOMPLETE                        (39756039L)
 178#define KG_CONTEXT                               (39756040L)
 179#define KG_CRED                                  (39756041L)
 180#define KG_ENC_DESC                              (39756042L)
 181#define KG_BAD_SEQ                               (39756043L)
 182#define KG_EMPTY_CCACHE                          (39756044L)
 183#define KG_NO_CTYPES                             (39756045L)
 184
 185/* per Kerberos v5 protocol spec crypto types from the wire. 
 186 * these get mapped to linux kernel crypto routines.  
 187 */
 188#define ENCTYPE_NULL            0x0000
 189#define ENCTYPE_DES_CBC_CRC     0x0001  /* DES cbc mode with CRC-32 */
 190#define ENCTYPE_DES_CBC_MD4     0x0002  /* DES cbc mode with RSA-MD4 */
 191#define ENCTYPE_DES_CBC_MD5     0x0003  /* DES cbc mode with RSA-MD5 */
 192#define ENCTYPE_DES_CBC_RAW     0x0004  /* DES cbc mode raw */
 193/* XXX deprecated? */
 194#define ENCTYPE_DES3_CBC_SHA    0x0005  /* DES-3 cbc mode with NIST-SHA */
 195#define ENCTYPE_DES3_CBC_RAW    0x0006  /* DES-3 cbc mode raw */
 196#define ENCTYPE_DES_HMAC_SHA1   0x0008
 197#define ENCTYPE_DES3_CBC_SHA1   0x0010
 198#define ENCTYPE_AES128_CTS_HMAC_SHA1_96 0x0011
 199#define ENCTYPE_AES256_CTS_HMAC_SHA1_96 0x0012
 200#define ENCTYPE_ARCFOUR_HMAC            0x0017
 201#define ENCTYPE_ARCFOUR_HMAC_EXP        0x0018
 202#define ENCTYPE_UNKNOWN         0x01ff
 203
 204/*
 205 * Constants used for key derivation
 206 */
 207/* for 3DES */
 208#define KG_USAGE_SEAL (22)
 209#define KG_USAGE_SIGN (23)
 210#define KG_USAGE_SEQ  (24)
 211
 212/* from rfc3961 */
 213#define KEY_USAGE_SEED_CHECKSUM         (0x99)
 214#define KEY_USAGE_SEED_ENCRYPTION       (0xAA)
 215#define KEY_USAGE_SEED_INTEGRITY        (0x55)
 216
 217/* from rfc4121 */
 218#define KG_USAGE_ACCEPTOR_SEAL  (22)
 219#define KG_USAGE_ACCEPTOR_SIGN  (23)
 220#define KG_USAGE_INITIATOR_SEAL (24)
 221#define KG_USAGE_INITIATOR_SIGN (25)
 222
 223/*
 224 * This compile-time check verifies that we will not exceed the
 225 * slack space allotted by the client and server auth_gss code
 226 * before they call gss_wrap().
 227 */
 228#define GSS_KRB5_MAX_SLACK_NEEDED \
 229        (GSS_KRB5_TOK_HDR_LEN     /* gss token header */         \
 230        + GSS_KRB5_MAX_CKSUM_LEN  /* gss token checksum */       \
 231        + GSS_KRB5_MAX_BLOCKSIZE  /* confounder */               \
 232        + GSS_KRB5_MAX_BLOCKSIZE  /* possible padding */         \
 233        + GSS_KRB5_TOK_HDR_LEN    /* encrypted hdr in v2 token */\
 234        + GSS_KRB5_MAX_CKSUM_LEN  /* encryption hmac */          \
 235        + 4 + 4                   /* RPC verifier */             \
 236        + GSS_KRB5_TOK_HDR_LEN                                   \
 237        + GSS_KRB5_MAX_CKSUM_LEN)
 238
 239u32
 240make_checksum(struct krb5_ctx *kctx, char *header, int hdrlen,
 241                struct xdr_buf *body, int body_offset, u8 *cksumkey,
 242                unsigned int usage, struct xdr_netobj *cksumout);
 243
 244u32
 245make_checksum_v2(struct krb5_ctx *, char *header, int hdrlen,
 246                 struct xdr_buf *body, int body_offset, u8 *key,
 247                 unsigned int usage, struct xdr_netobj *cksum);
 248
 249u32 gss_get_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
 250                struct xdr_netobj *);
 251
 252u32 gss_verify_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
 253                struct xdr_netobj *);
 254
 255u32
 256gss_wrap_kerberos(struct gss_ctx *ctx_id, int offset,
 257                struct xdr_buf *outbuf, struct page **pages);
 258
 259u32
 260gss_unwrap_kerberos(struct gss_ctx *ctx_id, int offset,
 261                struct xdr_buf *buf);
 262
 263
 264u32
 265krb5_encrypt(struct crypto_skcipher *key,
 266             void *iv, void *in, void *out, int length);
 267
 268u32
 269krb5_decrypt(struct crypto_skcipher *key,
 270             void *iv, void *in, void *out, int length); 
 271
 272int
 273gss_encrypt_xdr_buf(struct crypto_skcipher *tfm, struct xdr_buf *outbuf,
 274                    int offset, struct page **pages);
 275
 276int
 277gss_decrypt_xdr_buf(struct crypto_skcipher *tfm, struct xdr_buf *inbuf,
 278                    int offset);
 279
 280s32
 281krb5_make_seq_num(struct krb5_ctx *kctx,
 282                struct crypto_skcipher *key,
 283                int direction,
 284                u32 seqnum, unsigned char *cksum, unsigned char *buf);
 285
 286s32
 287krb5_get_seq_num(struct krb5_ctx *kctx,
 288               unsigned char *cksum,
 289               unsigned char *buf, int *direction, u32 *seqnum);
 290
 291int
 292xdr_extend_head(struct xdr_buf *buf, unsigned int base, unsigned int shiftlen);
 293
 294u32
 295krb5_derive_key(const struct gss_krb5_enctype *gk5e,
 296                const struct xdr_netobj *inkey,
 297                struct xdr_netobj *outkey,
 298                const struct xdr_netobj *in_constant,
 299                gfp_t gfp_mask);
 300
 301u32
 302gss_krb5_des3_make_key(const struct gss_krb5_enctype *gk5e,
 303                       struct xdr_netobj *randombits,
 304                       struct xdr_netobj *key);
 305
 306u32
 307gss_krb5_aes_make_key(const struct gss_krb5_enctype *gk5e,
 308                      struct xdr_netobj *randombits,
 309                      struct xdr_netobj *key);
 310
 311u32
 312gss_krb5_aes_encrypt(struct krb5_ctx *kctx, u32 offset,
 313                     struct xdr_buf *buf,
 314                     struct page **pages);
 315
 316u32
 317gss_krb5_aes_decrypt(struct krb5_ctx *kctx, u32 offset,
 318                     struct xdr_buf *buf, u32 *plainoffset,
 319                     u32 *plainlen);
 320
 321int
 322krb5_rc4_setup_seq_key(struct krb5_ctx *kctx,
 323                       struct crypto_skcipher *cipher,
 324                       unsigned char *cksum);
 325
 326int
 327krb5_rc4_setup_enc_key(struct krb5_ctx *kctx,
 328                       struct crypto_skcipher *cipher,
 329                       s32 seqnum);
 330void
 331gss_krb5_make_confounder(char *p, u32 conflen);
 332