1 // SPDX-License-Identifier: BSD-3-Clause
3 * linux/net/sunrpc/gss_krb5_mech.c
5 * Copyright (c) 2001-2008 The Regents of the University of Michigan.
8 * Andy Adamson <andros@umich.edu>
9 * J. Bruce Fields <bfields@umich.edu>
12 #include <crypto/hash.h>
13 #include <crypto/skcipher.h>
14 #include <linux/err.h>
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/types.h>
18 #include <linux/slab.h>
19 #include <linux/sunrpc/auth.h>
20 #include <linux/sunrpc/gss_krb5.h>
21 #include <linux/sunrpc/xdr.h>
22 #include <kunit/visibility.h>
24 #include "auth_gss_internal.h"
25 #include "gss_krb5_internal.h"
27 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
28 # define RPCDBG_FACILITY RPCDBG_AUTH
31 static struct gss_api_mech gss_kerberos_mech;
32 static int gss_krb5_import_ctx_v2(struct krb5_ctx *ctx, gfp_t gfp_mask);
34 static const struct gss_krb5_enctype supported_gss_krb5_enctypes[] = {
35 #if defined(CONFIG_RPCSEC_GSS_KRB5_ENCTYPES_AES_SHA1)
37 * AES-128 with SHA-1 (RFC 3962)
40 .etype = ENCTYPE_AES128_CTS_HMAC_SHA1_96,
41 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES128,
43 .encrypt_name = "cts(cbc(aes))",
44 .aux_cipher = "cbc(aes)",
45 .cksum_name = "hmac(sha1)",
46 .import_ctx = gss_krb5_import_ctx_v2,
47 .derive_key = krb5_derive_key_v2,
48 .encrypt = gss_krb5_aes_encrypt,
49 .decrypt = gss_krb5_aes_decrypt,
51 .get_mic = gss_krb5_get_mic_v2,
52 .verify_mic = gss_krb5_verify_mic_v2,
53 .wrap = gss_krb5_wrap_v2,
54 .unwrap = gss_krb5_unwrap_v2,
59 .keylength = BITS2OCTETS(128),
60 .Kc_length = BITS2OCTETS(128),
61 .Ke_length = BITS2OCTETS(128),
62 .Ki_length = BITS2OCTETS(128),
63 .cksumlength = BITS2OCTETS(96),
67 * AES-256 with SHA-1 (RFC 3962)
70 .etype = ENCTYPE_AES256_CTS_HMAC_SHA1_96,
71 .ctype = CKSUMTYPE_HMAC_SHA1_96_AES256,
73 .encrypt_name = "cts(cbc(aes))",
74 .aux_cipher = "cbc(aes)",
75 .cksum_name = "hmac(sha1)",
76 .import_ctx = gss_krb5_import_ctx_v2,
77 .derive_key = krb5_derive_key_v2,
78 .encrypt = gss_krb5_aes_encrypt,
79 .decrypt = gss_krb5_aes_decrypt,
81 .get_mic = gss_krb5_get_mic_v2,
82 .verify_mic = gss_krb5_verify_mic_v2,
83 .wrap = gss_krb5_wrap_v2,
84 .unwrap = gss_krb5_unwrap_v2,
89 .keylength = BITS2OCTETS(256),
90 .Kc_length = BITS2OCTETS(256),
91 .Ke_length = BITS2OCTETS(256),
92 .Ki_length = BITS2OCTETS(256),
93 .cksumlength = BITS2OCTETS(96),
98 #if defined(CONFIG_RPCSEC_GSS_KRB5_ENCTYPES_CAMELLIA)
100 * Camellia-128 with CMAC (RFC 6803)
103 .etype = ENCTYPE_CAMELLIA128_CTS_CMAC,
104 .ctype = CKSUMTYPE_CMAC_CAMELLIA128,
105 .name = "camellia128-cts-cmac",
106 .encrypt_name = "cts(cbc(camellia))",
107 .aux_cipher = "cbc(camellia)",
108 .cksum_name = "cmac(camellia)",
109 .cksumlength = BITS2OCTETS(128),
111 .keylength = BITS2OCTETS(128),
112 .Kc_length = BITS2OCTETS(128),
113 .Ke_length = BITS2OCTETS(128),
114 .Ki_length = BITS2OCTETS(128),
116 .import_ctx = gss_krb5_import_ctx_v2,
117 .derive_key = krb5_kdf_feedback_cmac,
118 .encrypt = gss_krb5_aes_encrypt,
119 .decrypt = gss_krb5_aes_decrypt,
121 .get_mic = gss_krb5_get_mic_v2,
122 .verify_mic = gss_krb5_verify_mic_v2,
123 .wrap = gss_krb5_wrap_v2,
124 .unwrap = gss_krb5_unwrap_v2,
127 * Camellia-256 with CMAC (RFC 6803)
130 .etype = ENCTYPE_CAMELLIA256_CTS_CMAC,
131 .ctype = CKSUMTYPE_CMAC_CAMELLIA256,
132 .name = "camellia256-cts-cmac",
133 .encrypt_name = "cts(cbc(camellia))",
134 .aux_cipher = "cbc(camellia)",
135 .cksum_name = "cmac(camellia)",
136 .cksumlength = BITS2OCTETS(128),
138 .keylength = BITS2OCTETS(256),
139 .Kc_length = BITS2OCTETS(256),
140 .Ke_length = BITS2OCTETS(256),
141 .Ki_length = BITS2OCTETS(256),
143 .import_ctx = gss_krb5_import_ctx_v2,
144 .derive_key = krb5_kdf_feedback_cmac,
145 .encrypt = gss_krb5_aes_encrypt,
146 .decrypt = gss_krb5_aes_decrypt,
148 .get_mic = gss_krb5_get_mic_v2,
149 .verify_mic = gss_krb5_verify_mic_v2,
150 .wrap = gss_krb5_wrap_v2,
151 .unwrap = gss_krb5_unwrap_v2,
155 #if defined(CONFIG_RPCSEC_GSS_KRB5_ENCTYPES_AES_SHA2)
157 * AES-128 with SHA-256 (RFC 8009)
160 .etype = ENCTYPE_AES128_CTS_HMAC_SHA256_128,
161 .ctype = CKSUMTYPE_HMAC_SHA256_128_AES128,
162 .name = "aes128-cts-hmac-sha256-128",
163 .encrypt_name = "cts(cbc(aes))",
164 .aux_cipher = "cbc(aes)",
165 .cksum_name = "hmac(sha256)",
166 .cksumlength = BITS2OCTETS(128),
168 .keylength = BITS2OCTETS(128),
169 .Kc_length = BITS2OCTETS(128),
170 .Ke_length = BITS2OCTETS(128),
171 .Ki_length = BITS2OCTETS(128),
173 .import_ctx = gss_krb5_import_ctx_v2,
174 .derive_key = krb5_kdf_hmac_sha2,
175 .encrypt = krb5_etm_encrypt,
176 .decrypt = krb5_etm_decrypt,
178 .get_mic = gss_krb5_get_mic_v2,
179 .verify_mic = gss_krb5_verify_mic_v2,
180 .wrap = gss_krb5_wrap_v2,
181 .unwrap = gss_krb5_unwrap_v2,
184 * AES-256 with SHA-384 (RFC 8009)
187 .etype = ENCTYPE_AES256_CTS_HMAC_SHA384_192,
188 .ctype = CKSUMTYPE_HMAC_SHA384_192_AES256,
189 .name = "aes256-cts-hmac-sha384-192",
190 .encrypt_name = "cts(cbc(aes))",
191 .aux_cipher = "cbc(aes)",
192 .cksum_name = "hmac(sha384)",
193 .cksumlength = BITS2OCTETS(192),
195 .keylength = BITS2OCTETS(256),
196 .Kc_length = BITS2OCTETS(192),
197 .Ke_length = BITS2OCTETS(256),
198 .Ki_length = BITS2OCTETS(192),
200 .import_ctx = gss_krb5_import_ctx_v2,
201 .derive_key = krb5_kdf_hmac_sha2,
202 .encrypt = krb5_etm_encrypt,
203 .decrypt = krb5_etm_decrypt,
205 .get_mic = gss_krb5_get_mic_v2,
206 .verify_mic = gss_krb5_verify_mic_v2,
207 .wrap = gss_krb5_wrap_v2,
208 .unwrap = gss_krb5_unwrap_v2,
214 * The list of advertised enctypes is specified in order of most
215 * preferred to least.
217 static char gss_krb5_enctype_priority_list[64];
219 static void gss_krb5_prepare_enctype_priority_list(void)
221 static const u32 gss_krb5_enctypes[] = {
222 #if defined(CONFIG_RPCSEC_GSS_KRB5_ENCTYPES_AES_SHA2)
223 ENCTYPE_AES256_CTS_HMAC_SHA384_192,
224 ENCTYPE_AES128_CTS_HMAC_SHA256_128,
226 #if defined(CONFIG_RPCSEC_GSS_KRB5_ENCTYPES_CAMELLIA)
227 ENCTYPE_CAMELLIA256_CTS_CMAC,
228 ENCTYPE_CAMELLIA128_CTS_CMAC,
230 #if defined(CONFIG_RPCSEC_GSS_KRB5_ENCTYPES_AES_SHA1)
231 ENCTYPE_AES256_CTS_HMAC_SHA1_96,
232 ENCTYPE_AES128_CTS_HMAC_SHA1_96,
241 gss_krb5_enctype_priority_list[0] = '\0';
242 for (total = 0, i = 0; i < ARRAY_SIZE(gss_krb5_enctypes); i++) {
243 n = sprintf(buf, "%s%u", sep, gss_krb5_enctypes[i]);
246 if (total + n >= sizeof(gss_krb5_enctype_priority_list))
248 strcat(gss_krb5_enctype_priority_list, buf);
255 * gss_krb5_lookup_enctype - Retrieve profile information for a given enctype
256 * @etype: ENCTYPE value
258 * Returns a pointer to a gss_krb5_enctype structure, or NULL if no
259 * matching etype is found.
262 const struct gss_krb5_enctype *gss_krb5_lookup_enctype(u32 etype)
266 for (i = 0; i < ARRAY_SIZE(supported_gss_krb5_enctypes); i++)
267 if (supported_gss_krb5_enctypes[i].etype == etype)
268 return &supported_gss_krb5_enctypes[i];
271 EXPORT_SYMBOL_IF_KUNIT(gss_krb5_lookup_enctype);
273 static struct crypto_sync_skcipher *
274 gss_krb5_alloc_cipher_v2(const char *cname, const struct xdr_netobj *key)
276 struct crypto_sync_skcipher *tfm;
278 tfm = crypto_alloc_sync_skcipher(cname, 0, 0);
281 if (crypto_sync_skcipher_setkey(tfm, key->data, key->len)) {
282 crypto_free_sync_skcipher(tfm);
288 static struct crypto_ahash *
289 gss_krb5_alloc_hash_v2(struct krb5_ctx *kctx, const struct xdr_netobj *key)
291 struct crypto_ahash *tfm;
293 tfm = crypto_alloc_ahash(kctx->gk5e->cksum_name, 0, CRYPTO_ALG_ASYNC);
296 if (crypto_ahash_setkey(tfm, key->data, key->len)) {
297 crypto_free_ahash(tfm);
304 gss_krb5_import_ctx_v2(struct krb5_ctx *ctx, gfp_t gfp_mask)
306 struct xdr_netobj keyin = {
307 .len = ctx->gk5e->keylength,
310 struct xdr_netobj keyout;
313 keyout.data = kmalloc(GSS_KRB5_MAX_KEYLEN, gfp_mask);
317 /* initiator seal encryption */
318 keyout.len = ctx->gk5e->Ke_length;
319 if (krb5_derive_key(ctx, &keyin, &keyout, KG_USAGE_INITIATOR_SEAL,
320 KEY_USAGE_SEED_ENCRYPTION, gfp_mask))
322 ctx->initiator_enc = gss_krb5_alloc_cipher_v2(ctx->gk5e->encrypt_name,
324 if (ctx->initiator_enc == NULL)
326 if (ctx->gk5e->aux_cipher) {
327 ctx->initiator_enc_aux =
328 gss_krb5_alloc_cipher_v2(ctx->gk5e->aux_cipher,
330 if (ctx->initiator_enc_aux == NULL)
334 /* acceptor seal encryption */
335 if (krb5_derive_key(ctx, &keyin, &keyout, KG_USAGE_ACCEPTOR_SEAL,
336 KEY_USAGE_SEED_ENCRYPTION, gfp_mask))
338 ctx->acceptor_enc = gss_krb5_alloc_cipher_v2(ctx->gk5e->encrypt_name,
340 if (ctx->acceptor_enc == NULL)
342 if (ctx->gk5e->aux_cipher) {
343 ctx->acceptor_enc_aux =
344 gss_krb5_alloc_cipher_v2(ctx->gk5e->aux_cipher,
346 if (ctx->acceptor_enc_aux == NULL)
350 /* initiator sign checksum */
351 keyout.len = ctx->gk5e->Kc_length;
352 if (krb5_derive_key(ctx, &keyin, &keyout, KG_USAGE_INITIATOR_SIGN,
353 KEY_USAGE_SEED_CHECKSUM, gfp_mask))
355 ctx->initiator_sign = gss_krb5_alloc_hash_v2(ctx, &keyout);
356 if (ctx->initiator_sign == NULL)
359 /* acceptor sign checksum */
360 if (krb5_derive_key(ctx, &keyin, &keyout, KG_USAGE_ACCEPTOR_SIGN,
361 KEY_USAGE_SEED_CHECKSUM, gfp_mask))
363 ctx->acceptor_sign = gss_krb5_alloc_hash_v2(ctx, &keyout);
364 if (ctx->acceptor_sign == NULL)
367 /* initiator seal integrity */
368 keyout.len = ctx->gk5e->Ki_length;
369 if (krb5_derive_key(ctx, &keyin, &keyout, KG_USAGE_INITIATOR_SEAL,
370 KEY_USAGE_SEED_INTEGRITY, gfp_mask))
372 ctx->initiator_integ = gss_krb5_alloc_hash_v2(ctx, &keyout);
373 if (ctx->initiator_integ == NULL)
376 /* acceptor seal integrity */
377 if (krb5_derive_key(ctx, &keyin, &keyout, KG_USAGE_ACCEPTOR_SEAL,
378 KEY_USAGE_SEED_INTEGRITY, gfp_mask))
380 ctx->acceptor_integ = gss_krb5_alloc_hash_v2(ctx, &keyout);
381 if (ctx->acceptor_integ == NULL)
386 kfree_sensitive(keyout.data);
390 crypto_free_ahash(ctx->acceptor_integ);
391 crypto_free_ahash(ctx->initiator_integ);
392 crypto_free_ahash(ctx->acceptor_sign);
393 crypto_free_ahash(ctx->initiator_sign);
394 crypto_free_sync_skcipher(ctx->acceptor_enc_aux);
395 crypto_free_sync_skcipher(ctx->acceptor_enc);
396 crypto_free_sync_skcipher(ctx->initiator_enc_aux);
397 crypto_free_sync_skcipher(ctx->initiator_enc);
402 gss_import_v2_context(const void *p, const void *end, struct krb5_ctx *ctx,
409 p = simple_get_bytes(p, end, &ctx->flags, sizeof(ctx->flags));
412 ctx->initiate = ctx->flags & KRB5_CTX_FLAG_INITIATOR;
414 p = simple_get_bytes(p, end, &time32, sizeof(time32));
417 /* unsigned 32-bit time overflows in year 2106 */
418 ctx->endtime = (time64_t)time32;
419 p = simple_get_bytes(p, end, &seq_send64, sizeof(seq_send64));
422 atomic64_set(&ctx->seq_send64, seq_send64);
423 /* set seq_send for use by "older" enctypes */
424 atomic_set(&ctx->seq_send, seq_send64);
425 if (seq_send64 != atomic_read(&ctx->seq_send)) {
426 dprintk("%s: seq_send64 %llx, seq_send %x overflow?\n", __func__,
427 seq_send64, atomic_read(&ctx->seq_send));
428 p = ERR_PTR(-EINVAL);
431 p = simple_get_bytes(p, end, &ctx->enctype, sizeof(ctx->enctype));
434 /* Map ENCTYPE_DES3_CBC_SHA1 to ENCTYPE_DES3_CBC_RAW */
435 if (ctx->enctype == ENCTYPE_DES3_CBC_SHA1)
436 ctx->enctype = ENCTYPE_DES3_CBC_RAW;
437 ctx->gk5e = gss_krb5_lookup_enctype(ctx->enctype);
438 if (ctx->gk5e == NULL) {
439 dprintk("gss_kerberos_mech: unsupported krb5 enctype %u\n",
441 p = ERR_PTR(-EINVAL);
444 keylen = ctx->gk5e->keylength;
446 p = simple_get_bytes(p, end, ctx->Ksess, keylen);
451 p = ERR_PTR(-EINVAL);
455 ctx->mech_used.data = kmemdup(gss_kerberos_mech.gm_oid.data,
456 gss_kerberos_mech.gm_oid.len, gfp_mask);
457 if (unlikely(ctx->mech_used.data == NULL)) {
458 p = ERR_PTR(-ENOMEM);
461 ctx->mech_used.len = gss_kerberos_mech.gm_oid.len;
463 return ctx->gk5e->import_ctx(ctx, gfp_mask);
470 gss_krb5_import_sec_context(const void *p, size_t len, struct gss_ctx *ctx_id,
471 time64_t *endtime, gfp_t gfp_mask)
473 const void *end = (const void *)((const char *)p + len);
474 struct krb5_ctx *ctx;
477 ctx = kzalloc(sizeof(*ctx), gfp_mask);
481 ret = gss_import_v2_context(p, end, ctx, gfp_mask);
482 memzero_explicit(&ctx->Ksess, sizeof(ctx->Ksess));
488 ctx_id->internal_ctx_id = ctx;
490 *endtime = ctx->endtime;
495 gss_krb5_delete_sec_context(void *internal_ctx)
497 struct krb5_ctx *kctx = internal_ctx;
499 crypto_free_sync_skcipher(kctx->seq);
500 crypto_free_sync_skcipher(kctx->enc);
501 crypto_free_sync_skcipher(kctx->acceptor_enc);
502 crypto_free_sync_skcipher(kctx->initiator_enc);
503 crypto_free_sync_skcipher(kctx->acceptor_enc_aux);
504 crypto_free_sync_skcipher(kctx->initiator_enc_aux);
505 crypto_free_ahash(kctx->acceptor_sign);
506 crypto_free_ahash(kctx->initiator_sign);
507 crypto_free_ahash(kctx->acceptor_integ);
508 crypto_free_ahash(kctx->initiator_integ);
509 kfree(kctx->mech_used.data);
514 * gss_krb5_get_mic - get_mic for the Kerberos GSS mechanism
516 * @text: plaintext to checksum
517 * @token: buffer into which to write the computed checksum
520 * %GSS_S_COMPLETE - success, and @token is filled in
521 * %GSS_S_FAILURE - checksum could not be generated
522 * %GSS_S_CONTEXT_EXPIRED - Kerberos context is no longer valid
524 static u32 gss_krb5_get_mic(struct gss_ctx *gctx, struct xdr_buf *text,
525 struct xdr_netobj *token)
527 struct krb5_ctx *kctx = gctx->internal_ctx_id;
529 return kctx->gk5e->get_mic(kctx, text, token);
533 * gss_krb5_verify_mic - verify_mic for the Kerberos GSS mechanism
535 * @message_buffer: plaintext to check
536 * @read_token: received checksum to check
539 * %GSS_S_COMPLETE - computed and received checksums match
540 * %GSS_S_DEFECTIVE_TOKEN - received checksum is not valid
541 * %GSS_S_BAD_SIG - computed and received checksums do not match
542 * %GSS_S_FAILURE - received checksum could not be checked
543 * %GSS_S_CONTEXT_EXPIRED - Kerberos context is no longer valid
545 static u32 gss_krb5_verify_mic(struct gss_ctx *gctx,
546 struct xdr_buf *message_buffer,
547 struct xdr_netobj *read_token)
549 struct krb5_ctx *kctx = gctx->internal_ctx_id;
551 return kctx->gk5e->verify_mic(kctx, message_buffer, read_token);
555 * gss_krb5_wrap - gss_wrap for the Kerberos GSS mechanism
556 * @gctx: initialized GSS context
557 * @offset: byte offset in @buf to start writing the cipher text
558 * @buf: OUT: send buffer
559 * @pages: plaintext to wrap
562 * %GSS_S_COMPLETE - success, @buf has been updated
563 * %GSS_S_FAILURE - @buf could not be wrapped
564 * %GSS_S_CONTEXT_EXPIRED - Kerberos context is no longer valid
566 static u32 gss_krb5_wrap(struct gss_ctx *gctx, int offset,
567 struct xdr_buf *buf, struct page **pages)
569 struct krb5_ctx *kctx = gctx->internal_ctx_id;
571 return kctx->gk5e->wrap(kctx, offset, buf, pages);
575 * gss_krb5_unwrap - gss_unwrap for the Kerberos GSS mechanism
576 * @gctx: initialized GSS context
577 * @offset: starting byte offset into @buf
578 * @len: size of ciphertext to unwrap
579 * @buf: ciphertext to unwrap
582 * %GSS_S_COMPLETE - success, @buf has been updated
583 * %GSS_S_DEFECTIVE_TOKEN - received blob is not valid
584 * %GSS_S_BAD_SIG - computed and received checksums do not match
585 * %GSS_S_FAILURE - @buf could not be unwrapped
586 * %GSS_S_CONTEXT_EXPIRED - Kerberos context is no longer valid
588 static u32 gss_krb5_unwrap(struct gss_ctx *gctx, int offset,
589 int len, struct xdr_buf *buf)
591 struct krb5_ctx *kctx = gctx->internal_ctx_id;
593 return kctx->gk5e->unwrap(kctx, offset, len, buf,
594 &gctx->slack, &gctx->align);
597 static const struct gss_api_ops gss_kerberos_ops = {
598 .gss_import_sec_context = gss_krb5_import_sec_context,
599 .gss_get_mic = gss_krb5_get_mic,
600 .gss_verify_mic = gss_krb5_verify_mic,
601 .gss_wrap = gss_krb5_wrap,
602 .gss_unwrap = gss_krb5_unwrap,
603 .gss_delete_sec_context = gss_krb5_delete_sec_context,
606 static struct pf_desc gss_kerberos_pfs[] = {
608 .pseudoflavor = RPC_AUTH_GSS_KRB5,
609 .qop = GSS_C_QOP_DEFAULT,
610 .service = RPC_GSS_SVC_NONE,
614 .pseudoflavor = RPC_AUTH_GSS_KRB5I,
615 .qop = GSS_C_QOP_DEFAULT,
616 .service = RPC_GSS_SVC_INTEGRITY,
621 .pseudoflavor = RPC_AUTH_GSS_KRB5P,
622 .qop = GSS_C_QOP_DEFAULT,
623 .service = RPC_GSS_SVC_PRIVACY,
629 MODULE_ALIAS("rpc-auth-gss-krb5");
630 MODULE_ALIAS("rpc-auth-gss-krb5i");
631 MODULE_ALIAS("rpc-auth-gss-krb5p");
632 MODULE_ALIAS("rpc-auth-gss-390003");
633 MODULE_ALIAS("rpc-auth-gss-390004");
634 MODULE_ALIAS("rpc-auth-gss-390005");
635 MODULE_ALIAS("rpc-auth-gss-1.2.840.113554.1.2.2");
637 static struct gss_api_mech gss_kerberos_mech = {
639 .gm_owner = THIS_MODULE,
640 .gm_oid = { 9, "\x2a\x86\x48\x86\xf7\x12\x01\x02\x02" },
641 .gm_ops = &gss_kerberos_ops,
642 .gm_pf_num = ARRAY_SIZE(gss_kerberos_pfs),
643 .gm_pfs = gss_kerberos_pfs,
644 .gm_upcall_enctypes = gss_krb5_enctype_priority_list,
647 static int __init init_kerberos_module(void)
651 gss_krb5_prepare_enctype_priority_list();
652 status = gss_mech_register(&gss_kerberos_mech);
654 printk("Failed to register kerberos gss mechanism!\n");
658 static void __exit cleanup_kerberos_module(void)
660 gss_mech_unregister(&gss_kerberos_mech);
663 MODULE_LICENSE("GPL");
664 module_init(init_kerberos_module);
665 module_exit(cleanup_kerberos_module);