]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/sunrpc/gss_krb5.h
License cleanup: add SPDX GPL-2.0 license identifier to files with no license
[mirror_ubuntu-bionic-kernel.git] / include / linux / sunrpc / gss_krb5.h
CommitLineData
1da177e4
LT
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 *
81d4a433 7 * Copyright (c) 2000-2008 The Regents of the University of Michigan.
1da177e4
LT
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
3b5cf20c 39#include <crypto/skcipher.h>
1da177e4
LT
40#include <linux/sunrpc/auth_gss.h>
41#include <linux/sunrpc/gss_err.h>
42#include <linux/sunrpc/gss_asn1.h>
43
4891f2d0
KC
44/* Length of constant used in key derivation */
45#define GSS_KRB5_K5CLENGTH (5)
46
e1f6c07b
KC
47/* Maximum key length (in bytes) for the supported crypto algorithms*/
48#define GSS_KRB5_MAX_KEYLEN (32)
49
725f2865
KC
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
de9c17eb
KC
56struct krb5_ctx;
57
81d4a433
KC
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 */
5af46547
KC
67 const u32 conflen; /* confounder length
68 (normally the same as
69 the blocksize) */
81d4a433
KC
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 */
3b5cf20c 74 u32 (*encrypt) (struct crypto_skcipher *tfm,
81d4a433
KC
75 void *iv, void *in, void *out,
76 int length); /* encryption function */
3b5cf20c 77 u32 (*decrypt) (struct crypto_skcipher *tfm,
81d4a433
KC
78 void *iv, void *in, void *out,
79 int length); /* decryption function */
47d84807 80 u32 (*mk_key) (const struct gss_krb5_enctype *gk5e,
4891f2d0
KC
81 struct xdr_netobj *in,
82 struct xdr_netobj *out); /* complete key generation */
de9c17eb 83 u32 (*encrypt_v2) (struct krb5_ctx *kctx, u32 offset,
ec25422c 84 struct xdr_buf *buf,
de9c17eb
KC
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 */
81d4a433
KC
89};
90
47d84807
KC
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
1da177e4
LT
96struct krb5_ctx {
97 int initiate; /* 1 = initiating, 0 = accepting */
1ac3719a 98 u32 enctype;
47d84807 99 u32 flags;
81d4a433 100 const struct gss_krb5_enctype *gk5e; /* enctype-specific info */
3b5cf20c
HX
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;
fc263a91 107 u8 Ksess[GSS_KRB5_MAX_KEYLEN]; /* session key */
e1f6c07b 108 u8 cksum[GSS_KRB5_MAX_KEYLEN];
1da177e4
LT
109 s32 endtime;
110 u32 seq_send;
47d84807 111 u64 seq_send64;
1da177e4 112 struct xdr_netobj mech_used;
47d84807
KC
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];
1da177e4
LT
119};
120
eaa82edf
BF
121extern spinlock_t krb5_seq_lock;
122
d00953a5
KC
123/* The length of the Kerberos GSS token header */
124#define GSS_KRB5_TOK_HDR_LEN (16)
125
1da177e4
LT
126#define KG_TOK_MIC_MSG 0x0101
127#define KG_TOK_WRAP_MSG 0x0201
128
de9c17eb
KC
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
1da177e4
LT
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
1da177e4
LT
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
de9c17eb
KC
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 */
1da177e4
LT
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
47d84807
KC
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
1da177e4
LT
202#define ENCTYPE_UNKNOWN 0x01ff
203
4891f2d0
KC
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
725f2865
KC
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
e1f6c07b
KC
239u32
240make_checksum(struct krb5_ctx *kctx, char *header, int hdrlen,
241 struct xdr_buf *body, int body_offset, u8 *cksumkey,
8b237076 242 unsigned int usage, struct xdr_netobj *cksumout);
1da177e4 243
de9c17eb
KC
244u32
245make_checksum_v2(struct krb5_ctx *, char *header, int hdrlen,
246 struct xdr_buf *body, int body_offset, u8 *key,
8b237076 247 unsigned int usage, struct xdr_netobj *cksum);
de9c17eb 248
a0857d03
BF
249u32 gss_get_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
250 struct xdr_netobj *);
1da177e4 251
a0857d03
BF
252u32 gss_verify_mic_kerberos(struct gss_ctx *, struct xdr_buf *,
253 struct xdr_netobj *);
1da177e4 254
14ae162c 255u32
00fd6e14 256gss_wrap_kerberos(struct gss_ctx *ctx_id, int offset,
14ae162c
BF
257 struct xdr_buf *outbuf, struct page **pages);
258
259u32
00fd6e14 260gss_unwrap_kerberos(struct gss_ctx *ctx_id, int offset,
14ae162c
BF
261 struct xdr_buf *buf);
262
263
1da177e4 264u32
3b5cf20c 265krb5_encrypt(struct crypto_skcipher *key,
1da177e4
LT
266 void *iv, void *in, void *out, int length);
267
268u32
3b5cf20c 269krb5_decrypt(struct crypto_skcipher *key,
1da177e4
LT
270 void *iv, void *in, void *out, int length);
271
14ae162c 272int
3b5cf20c 273gss_encrypt_xdr_buf(struct crypto_skcipher *tfm, struct xdr_buf *outbuf,
378c6697 274 int offset, struct page **pages);
14ae162c
BF
275
276int
3b5cf20c 277gss_decrypt_xdr_buf(struct crypto_skcipher *tfm, struct xdr_buf *inbuf,
378c6697 278 int offset);
14ae162c 279
1da177e4 280s32
1dbd9029 281krb5_make_seq_num(struct krb5_ctx *kctx,
3b5cf20c 282 struct crypto_skcipher *key,
1da177e4 283 int direction,
5743d65c 284 u32 seqnum, unsigned char *cksum, unsigned char *buf);
1da177e4
LT
285
286s32
1dbd9029 287krb5_get_seq_num(struct krb5_ctx *kctx,
1da177e4 288 unsigned char *cksum,
5743d65c 289 unsigned char *buf, int *direction, u32 *seqnum);
725f2865
KC
290
291int
292xdr_extend_head(struct xdr_buf *buf, unsigned int base, unsigned int shiftlen);
4891f2d0
KC
293
294u32
47d84807 295krb5_derive_key(const struct gss_krb5_enctype *gk5e,
4891f2d0
KC
296 const struct xdr_netobj *inkey,
297 struct xdr_netobj *outkey,
1f4c86c0
TM
298 const struct xdr_netobj *in_constant,
299 gfp_t gfp_mask);
958142e9
KC
300
301u32
302gss_krb5_des3_make_key(const struct gss_krb5_enctype *gk5e,
303 struct xdr_netobj *randombits,
304 struct xdr_netobj *key);
934a95aa
KC
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,
ec25422c 313 struct xdr_buf *buf,
934a95aa
KC
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
fffdaef2
KC
321int
322krb5_rc4_setup_seq_key(struct krb5_ctx *kctx,
3b5cf20c 323 struct crypto_skcipher *cipher,
fffdaef2
KC
324 unsigned char *cksum);
325
326int
327krb5_rc4_setup_enc_key(struct krb5_ctx *kctx,
3b5cf20c 328 struct crypto_skcipher *cipher,
fffdaef2 329 s32 seqnum);
934a95aa
KC
330void
331gss_krb5_make_confounder(char *p, u32 conflen);