6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20 * Copyright 2000,2001 The FreeRADIUS server project
25 * mschap.c MS-CHAP module
27 * This implements MS-CHAP, as described in RFC 2548
29 * http://www.freeradius.org/rfc/rfc2548.txt
34 * If you have any questions on NTLM (Samba) passwords
35 * support, LM authentication and MS-CHAP v2 support
38 * Vladimir Dubrovin vlad@sandy.ru
40 * ZARAZA 3APA3A@security.nnov.ru
43 /* MPPE support from Takahiro Wagatsuma <waga@sic.shibaura-it.ac.jp> */
46 #include "libradius.h"
59 #include "rad_assert.h"
63 static const char rcsid[] = "$Id$";
65 static const char *letters = "0123456789ABCDEF";
68 * hex2bin converts hexadecimal strings into binary
70 static int hex2bin (const char *szHex, unsigned char* szBin, int len)
75 for (i = 0; i < len; i++) {
76 if( !(c1 = memchr(letters, toupper((int) szHex[i << 1]), 16)) ||
77 !(c2 = memchr(letters, toupper((int) szHex[(i << 1) + 1]), 16)))
79 szBin[i] = ((c1-letters)<<4) + (c2-letters);
85 * bin2hex creates hexadecimal presentation
88 static void bin2hex (const unsigned char *szBin, char *szHex, int len)
91 for (i = 0; i < len; i++) {
92 szHex[i<<1] = letters[szBin[i] >> 4];
93 szHex[(i<<1) + 1] = letters[szBin[i] & 0x0F];
98 /* Allowable account control bits */
99 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
100 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
101 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
102 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
103 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
104 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
105 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
106 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
107 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
108 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
109 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
111 static int pdb_decode_acct_ctrl(const char *p)
117 * Check if the account type bits have been encoded after the
118 * NT password (in the form [NDHTUWSLXI]).
121 if (*p != '[') return 0;
123 for (p++; *p && !finished; p++) {
125 case 'N': /* 'N'o password. */
126 acct_ctrl |= ACB_PWNOTREQ;
129 case 'D': /* 'D'isabled. */
130 acct_ctrl |= ACB_DISABLED ;
133 case 'H': /* 'H'omedir required. */
134 acct_ctrl |= ACB_HOMDIRREQ;
137 case 'T': /* 'T'emp account. */
138 acct_ctrl |= ACB_TEMPDUP;
141 case 'U': /* 'U'ser account (normal). */
142 acct_ctrl |= ACB_NORMAL;
145 case 'M': /* 'M'NS logon user account. What is this? */
146 acct_ctrl |= ACB_MNS;
149 case 'W': /* 'W'orkstation account. */
150 acct_ctrl |= ACB_WSTRUST;
153 case 'S': /* 'S'erver account. */
154 acct_ctrl |= ACB_SVRTRUST;
157 case 'L': /* 'L'ocked account. */
158 acct_ctrl |= ACB_AUTOLOCK;
161 case 'X': /* No 'X'piry on password */
162 acct_ctrl |= ACB_PWNOEXP;
165 case 'I': /* 'I'nterdomain trust account. */
166 acct_ctrl |= ACB_DOMTRUST;
169 case ' ': /* ignore spaces */
187 * ntpwdhash converts Unicode password to 16-byte NT hash
190 static void ntpwdhash (unsigned char *szHash, const char *szPassword)
192 char szUnicodePass[513];
197 * NT passwords are unicode. Convert plain text password
198 * to unicode by inserting a zero every other byte
200 nPasswordLen = strlen(szPassword);
201 for (i = 0; i < nPasswordLen; i++) {
202 szUnicodePass[i << 1] = szPassword[i];
203 szUnicodePass[(i << 1) + 1] = 0;
206 /* Encrypt Unicode password to a 16-byte MD4 hash */
207 md4_calc(szHash, szUnicodePass, (nPasswordLen<<1) );
212 * challenge_hash() is used by mschap2() and auth_response()
213 * implements RFC2759 ChallengeHash()
214 * generates 64 bit challenge
216 static void challenge_hash( const char *peer_challenge,
217 const char *auth_challenge,
218 const char *user_name, char *challenge )
221 unsigned char hash[20];
224 SHA1Update(&Context, peer_challenge, 16);
225 SHA1Update(&Context, auth_challenge, 16);
226 SHA1Update(&Context, user_name, strlen(user_name));
227 SHA1Final(hash, &Context);
228 memcpy(challenge, hash, 8);
232 * auth_response() generates MS-CHAP v2 SUCCESS response
233 * according to RFC 2759 GenerateAuthenticatorResponse()
234 * returns 42-octet response string
236 static void auth_response(const char *username,
237 const unsigned char *nt_hash_hash,
238 unsigned char *ntresponse,
239 char *peer_challenge, char *auth_challenge,
243 const unsigned char magic1[39] =
244 {0x4D, 0x61, 0x67, 0x69, 0x63, 0x20, 0x73, 0x65, 0x72, 0x76,
245 0x65, 0x72, 0x20, 0x74, 0x6F, 0x20, 0x63, 0x6C, 0x69, 0x65,
246 0x6E, 0x74, 0x20, 0x73, 0x69, 0x67, 0x6E, 0x69, 0x6E, 0x67,
247 0x20, 0x63, 0x6F, 0x6E, 0x73, 0x74, 0x61, 0x6E, 0x74};
249 const unsigned char magic2[41] =
250 {0x50, 0x61, 0x64, 0x20, 0x74, 0x6F, 0x20, 0x6D, 0x61, 0x6B,
251 0x65, 0x20, 0x69, 0x74, 0x20, 0x64, 0x6F, 0x20, 0x6D, 0x6F,
252 0x72, 0x65, 0x20, 0x74, 0x68, 0x61, 0x6E, 0x20, 0x6F, 0x6E,
253 0x65, 0x20, 0x69, 0x74, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6F,
257 unsigned char digest[20];
260 SHA1Update(&Context, nt_hash_hash, 16);
261 SHA1Update(&Context, ntresponse, 24);
262 SHA1Update(&Context, magic1, 39);
263 SHA1Final(digest, &Context);
264 challenge_hash(peer_challenge, auth_challenge, username, challenge);
266 SHA1Update(&Context, digest, 20);
267 SHA1Update(&Context, challenge, 8);
268 SHA1Update(&Context, magic2, 41);
269 SHA1Final(digest, &Context);
272 * Encode the value of 'Digest' as "S=" followed by
273 * 40 ASCII hexadecimal digits and return it in
274 * AuthenticatorResponse.
276 * "S=0123456789ABCDEF0123456789ABCDEF01234567"
280 bin2hex(digest, response + 2, 20);
284 typedef struct rlm_mschap_t {
286 int require_encryption;
288 int with_ntdomain_hack; /* this should be in another module */
297 * Does dynamic translation of strings.
299 * Pulls NT-Response, LM-Response, or Challenge from MSCHAP
302 static int mschap_xlat(void *instance, REQUEST *request,
303 char *fmt, char *out, size_t outlen,
304 RADIUS_ESCAPE_STRING func)
307 uint8_t *data = NULL;
309 VALUE_PAIR *user_name;
310 VALUE_PAIR *chap_challenge, *response;
311 rlm_mschap_t *inst = instance;
313 chap_challenge = response = NULL;
315 func = func; /* -Wunused */
318 * Challenge means MS-CHAPv1 challenge, or
319 * hash of MS-CHAPv2 challenge, and peer challenge.
321 if (strcasecmp(fmt, "Challenge") == 0) {
322 chap_challenge = pairfind(request->packet->vps,
323 PW_MSCHAP_CHALLENGE);
324 if (!chap_challenge) {
325 DEBUG2(" rlm_mschap: No MS-CHAP-Challenge in the request.");
330 * MS-CHAP-Challenges are 8 octets,
333 if (chap_challenge->length == 8) {
334 DEBUG2(" mschap1: %02x", chap_challenge->strvalue[0]);
335 data = chap_challenge->strvalue;
339 * MS-CHAP-Challenges are 16 octets,
342 } else if (chap_challenge->length == 16) {
343 char *username_string;
345 DEBUG2(" mschap2: %02x", chap_challenge->strvalue[0]);
346 response = pairfind(request->packet->vps,
347 PW_MSCHAP2_RESPONSE);
349 DEBUG2(" rlm_mschap: MS-CHAP2-Response is required to calculate MS-CHAPv1 challenge.");
354 * Responses are 50 octets.
356 if (response->length < 50) {
357 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Response has the wrong format.");
361 user_name = pairfind(request->packet->vps,
364 DEBUG2(" rlm_mschap: User-Name is required to calculateMS-CHAPv1 Challenge.");
369 * with_ntdomain_hack moved here, too.
371 if ((username_string = strchr(user_name->strvalue, '\\')) != NULL) {
372 if (inst->with_ntdomain_hack) {
375 DEBUG2(" rlm_mschap: NT Domain delimeter found, should we have enabled with_ntdomain_hack?");
376 username_string = user_name->strvalue;
379 username_string = user_name->strvalue;
383 * Get the MS-CHAPv1 challenge
384 * from the MS-CHAPv2 peer challenge,
385 * our challenge, and the user name.
387 challenge_hash(response->strvalue + 2,
388 chap_challenge->strvalue,
389 username_string, buffer);
393 DEBUG2(" rlm_mschap: Invalid MS-CHAP challenge length");
398 * Get the MS-CHAPv1 response, or the MS-CHAPv2
401 } else if (strcasecmp(fmt, "NT-Response") == 0) {
402 response = pairfind(request->packet->vps,
404 if (!response) response = pairfind(request->packet->vps,
405 PW_MSCHAP2_RESPONSE);
407 DEBUG2(" rlm_mschap: No MS-CHAP-Response or MS-CHAP2-Response was found in the request.");
412 * For MS-CHAPv1, the NT-Response exists only
413 * if the second octet says so.
415 if ((response->attribute == PW_MSCHAP_RESPONSE) &&
416 ((response->strvalue[1] & 0x01) == 0)) {
417 DEBUG2(" rlm_mschap: No NT-Response in MS-CHAP-Response");
422 * MS-CHAP-Response and MS-CHAP2-Response have
423 * the NT-Response at the same offset, and are
426 data = response->strvalue + 26;
430 * LM-Response is deprecated, and exists only
431 * in MS-CHAPv1, and not often there.
433 } else if (strcasecmp(fmt, "LM-Response") == 0) {
434 response = pairfind(request->packet->vps,
437 DEBUG2(" rlm_mschap: No MS-CHAP-Response was found in the request.");
442 * For MS-CHAPv1, the NT-Response exists only
443 * if the second octet says so.
445 if ((response->strvalue[1] & 0x01) != 0) {
446 DEBUG2(" rlm_mschap: No LM-Response in MS-CHAP-Response");
449 data = response->strvalue + 2;
453 * Pull the NT-Domain out of the User-Name, if it exists.
455 } else if (strcasecmp(fmt, "NT-Domain") == 0) {
458 user_name = pairfind(request->packet->vps, PW_USER_NAME);
460 DEBUG2(" rlm_mschap: No User-Name was found in the request.");
465 * First check to see if this is a host/ style User-Name
466 * (a la Kerberos host principal)
468 if (strncmp(user_name->strvalue, "host/", 5) == 0) {
470 * If we're getting a User-Name formatted in this way,
471 * it's likely due to PEAP. The Windows Domain will be
472 * the first domain component following the hostname,
473 * or the machine name itself if only a hostname is supplied
475 p = strchr(user_name->strvalue, '.');
477 DEBUG2(" rlm_mschap: setting NT-Domain to same as machine name");
478 strNcpy(out, user_name->strvalue + 5, outlen);
480 p++; /* skip the period */
483 * use the same hack as below
484 * only if another period was found
487 strNcpy(out, p, outlen);
491 p = strchr(user_name->strvalue, '\\');
493 DEBUG2(" rlm_mschap: No NT-Domain was found in the User-Name.");
498 * Hack. This is simpler than the alternatives.
501 strNcpy(out, user_name->strvalue, outlen);
508 * Pull the User-Name out of the User-Name...
510 } else if (strcasecmp(fmt, "User-Name") == 0) {
513 user_name = pairfind(request->packet->vps, PW_USER_NAME);
515 DEBUG2(" rlm_mschap: No User-Name was found in the request.");
520 * First check to see if this is a host/ style User-Name
521 * (a la Kerberos host principal)
523 if (strncmp(user_name->strvalue, "host/", 5) == 0) {
525 * If we're getting a User-Name formatted in this way,
526 * it's likely due to PEAP. When authenticating this against
527 * a Domain, Windows will expect the User-Name to be in the
528 * format of hostname$, the SAM version of the name, so we
529 * have to convert it to that here. We do so by stripping
530 * off the first 5 characters (host/), and copying everything
531 * from that point to the first period into a string and appending
534 p = strchr(user_name->strvalue, '.');
536 * use the same hack as above
537 * only if a period was found
540 snprintf(out, outlen, "%s$", user_name->strvalue + 5);
543 p = strchr(user_name->strvalue, '\\');
545 p++; /* skip the backslash */
547 p = user_name->strvalue; /* use the whole User-Name */
549 strNcpy(out, p, outlen);
555 * Return the NT-Hash of the passed string
557 } else if (strncasecmp(fmt, "NT-Hash ", 8) == 0) {
560 p = fmt + 8; /* 7 is the length of 'NT-Hash' */
561 if ((p == '\0') || (outlen <= 32))
563 DEBUG("rlm_mschap: NT-Hash: %s",p);
566 lrad_bin2hex(buffer, out, 16);
568 DEBUG("rlm_mschap: NT-Hash: Result: %s",out);
572 * Return the LM-Hash of the passed string
574 } else if (strncasecmp(fmt, "LM-Hash ", 8) == 0) {
577 p = fmt + 8; /* 7 is the length of 'LM-Hash' */
578 if ((p == '\0') || (outlen <= 32))
581 DEBUG("rlm_mschap: LM-Hash: %s",p);
582 smbdes_lmpwdhash(p,buffer);
583 lrad_bin2hex(buffer, out, 16);
585 DEBUG("rlm_mschap: LM-Hash: Result: %s",out);
588 DEBUG2(" rlm_mschap: Unknown expansion string \"%s\"",
593 if (outlen == 0) return 0; /* nowhere to go, don't do anything */
596 * Didn't set anything: this is bad.
599 DEBUG2(" rlm_mschap: Failed to do anything intelligent");
604 * Check the output length.
606 if (outlen < ((data_len * 2) + 1)) {
607 data_len = (outlen - 1) / 2;
613 for (i = 0; i < data_len; i++) {
614 sprintf(out + (2 * i), "%02x", data[i]);
616 out[data_len * 2] = '\0';
622 static CONF_PARSER module_config[] = {
624 * Cache the password by default.
626 { "use_mppe", PW_TYPE_BOOLEAN,
627 offsetof(rlm_mschap_t,use_mppe), NULL, "yes" },
628 { "require_encryption", PW_TYPE_BOOLEAN,
629 offsetof(rlm_mschap_t,require_encryption), NULL, "no" },
630 { "require_strong", PW_TYPE_BOOLEAN,
631 offsetof(rlm_mschap_t,require_strong), NULL, "no" },
632 { "with_ntdomain_hack", PW_TYPE_BOOLEAN,
633 offsetof(rlm_mschap_t,with_ntdomain_hack), NULL, "no" },
634 { "passwd", PW_TYPE_STRING_PTR,
635 offsetof(rlm_mschap_t, passwd_file), NULL, NULL },
636 { "ntlm_auth", PW_TYPE_STRING_PTR,
637 offsetof(rlm_mschap_t, ntlm_auth), NULL, NULL },
639 { NULL, -1, 0, NULL, NULL } /* end the list */
643 * deinstantiate module, free all memory allocated during
644 * mschap_instantiate()
646 static int mschap_detach(void *instance){
647 #define inst ((rlm_mschap_t *)instance)
648 free(inst->passwd_file);
649 free(inst->ntlm_auth);
650 if (inst->xlat_name) {
651 xlat_unregister(inst->xlat_name, mschap_xlat);
659 * Create instance for our module. Allocate space for
660 * instance structure and read configuration parameters
662 static int mschap_instantiate(CONF_SECTION *conf, void **instance)
666 inst = *instance = rad_malloc(sizeof(*inst));
670 memset(inst, 0, sizeof(*inst));
672 if (cf_section_parse(conf, inst, module_config) < 0) {
678 * This module used to support SMB Password files, but it
679 * made it too complicated. If the user tries to
680 * configure an SMB Password file, then die, with an
683 if (inst->passwd_file) {
684 radlog(L_ERR, "rlm_mschap: SMB password file is no longer supported in this module. Use rlm_passwd module instead");
690 * Create the dynamic translation.
692 inst->xlat_name = cf_section_name2(conf);
693 if (!inst->xlat_name) inst->xlat_name = cf_section_name1(conf);
694 xlat_register(inst->xlat_name, mschap_xlat, inst);
697 * For backwards compatibility
699 if (!dict_valbyname(PW_AUTH_TYPE, inst->xlat_name)) {
700 inst->auth_type = "MS-CHAP";
702 inst->auth_type = inst->xlat_name;
709 * add_reply() adds either MS-CHAP2-Success or MS-CHAP-Error
710 * attribute to reply packet
712 static void add_reply(VALUE_PAIR** vp, unsigned char ident,
713 const char* name, const char* value, int len)
715 VALUE_PAIR *reply_attr;
716 reply_attr = pairmake(name, "", T_OP_EQ);
718 DEBUG(" rlm_mschap: Failed to create attribute %s: %s\n", name, librad_errstr);
722 reply_attr->strvalue[0] = ident;
723 memcpy(reply_attr->strvalue + 1, value, len);
724 reply_attr->length = len + 1;
725 pairadd(vp, reply_attr);
729 * Add MPPE attributes to the reply.
731 static void mppe_add_reply(VALUE_PAIR **vp,
732 const char* name, const char* value, int len)
734 VALUE_PAIR *reply_attr;
735 reply_attr = pairmake(name, "", T_OP_EQ);
737 DEBUG("rlm_mschap: mppe_add_reply failed to create attribute %s: %s\n", name, librad_errstr);
741 memcpy(reply_attr->strvalue, value, len);
742 reply_attr->length = len;
743 pairadd(vp, reply_attr);
748 * Do the MS-CHAP stuff.
750 * This function is here so that all of the MS-CHAP related
751 * authentication is in one place, and we can perhaps later replace
752 * it with code to call winbindd, or something similar.
754 static int do_mschap(rlm_mschap_t *inst,
755 REQUEST *request, VALUE_PAIR *password,
756 uint8_t *challenge, uint8_t *response,
759 int do_ntlm_auth = 0;
760 uint8_t calculated[24];
761 VALUE_PAIR *vp = NULL;
764 * If we have ntlm_auth configured, use it unless told
767 if (inst->ntlm_auth) do_ntlm_auth = 1;
770 * If we have an ntlm_auth configuration, then we may
773 vp = pairfind(request->config_items,
774 PW_MS_CHAP_USE_NTLM_AUTH);
775 if (vp) do_ntlm_auth = vp->lvalue;
778 * No ntlm_auth configured, attribute to tell us to
779 * use it exists, and we're told to use it. We don't
782 if (!inst->ntlm_auth && do_ntlm_auth) {
783 DEBUG2(" rlm_mschap: Asked to use ntlm_auth, but it was not configured in the mschap{} section.");
788 * Do normal authentication.
792 * No password: can't do authentication.
795 DEBUG2(" rlm_mschap: FAILED: No NT/LM-Password. Cannot perform authentication.");
799 smbdes_mschap(password->strvalue, challenge, calculated);
800 if (memcmp(response, calculated, 24) != 0) {
805 * If the password exists, and is an NT-Password,
806 * then calculate the hash of the NT hash. Doing this
807 * here minimizes work for later.
809 if (password && (password->attribute == PW_NT_PASSWORD)) {
810 md4_calc(nthashhash, password->strvalue, 16);
812 memset(nthashhash, 0, 16);
814 } else { /* run ntlm_auth */
818 memset(nthashhash, 0, 16);
821 * Run the program, and expect that we get 16
823 result = radius_exec_program(inst->ntlm_auth, request,
825 buffer, sizeof(buffer),
830 DEBUG2(" rlm_mschap: External script failed.");
832 vp = pairmake("Module-Failure-Message", "", T_OP_EQ);
834 radlog(L_ERR, "No memory");
838 p = strchr(buffer, '\n');
840 snprintf(vp->strvalue, sizeof(vp->strvalue),
841 "rlm_mschap: %s", buffer);
842 vp->length = strlen(vp->strvalue);
843 pairadd(&request->packet->vps, vp);
848 * Parse the answer as an nthashhash.
850 * ntlm_auth currently returns:
851 * NT_KEY: 000102030405060708090a0b0c0d0e0f
853 if (memcmp(buffer, "NT_KEY: ", 8) != 0) {
854 DEBUG2(" rlm_mschap: Invalid output from ntlm_auth: expecting NT_KEY");
859 * Check the length. It should be at least 32,
860 * with an LF at the end.
862 if (strlen(buffer + 8) < 32) {
863 DEBUG2(" rlm_mschap: Invalid output from ntlm_auth: NT_KEY has unexpected length");
868 * Update the NT hash hash, from the NT key.
870 if (hex2bin(buffer + 8, nthashhash, 16) != 16) {
871 DEBUG2(" rlm_mschap: Invalid output from ntlm_auth: NT_KEY has non-hex values");
881 * Data for the hashes.
883 static const uint8_t SHSpad1[40] =
884 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
885 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
886 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
887 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
889 static const uint8_t SHSpad2[40] =
890 { 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2,
891 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2,
892 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2,
893 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2 };
895 static const uint8_t magic1[27] =
896 { 0x54, 0x68, 0x69, 0x73, 0x20, 0x69, 0x73, 0x20, 0x74,
897 0x68, 0x65, 0x20, 0x4d, 0x50, 0x50, 0x45, 0x20, 0x4d,
898 0x61, 0x73, 0x74, 0x65, 0x72, 0x20, 0x4b, 0x65, 0x79 };
900 static const uint8_t magic2[84] =
901 { 0x4f, 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x63, 0x6c, 0x69,
902 0x65, 0x6e, 0x74, 0x20, 0x73, 0x69, 0x64, 0x65, 0x2c, 0x20,
903 0x74, 0x68, 0x69, 0x73, 0x20, 0x69, 0x73, 0x20, 0x74, 0x68,
904 0x65, 0x20, 0x73, 0x65, 0x6e, 0x64, 0x20, 0x6b, 0x65, 0x79,
905 0x3b, 0x20, 0x6f, 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x73,
906 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x73, 0x69, 0x64, 0x65,
907 0x2c, 0x20, 0x69, 0x74, 0x20, 0x69, 0x73, 0x20, 0x74, 0x68,
908 0x65, 0x20, 0x72, 0x65, 0x63, 0x65, 0x69, 0x76, 0x65, 0x20,
909 0x6b, 0x65, 0x79, 0x2e };
911 static const uint8_t magic3[84] =
912 { 0x4f, 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x63, 0x6c, 0x69,
913 0x65, 0x6e, 0x74, 0x20, 0x73, 0x69, 0x64, 0x65, 0x2c, 0x20,
914 0x74, 0x68, 0x69, 0x73, 0x20, 0x69, 0x73, 0x20, 0x74, 0x68,
915 0x65, 0x20, 0x72, 0x65, 0x63, 0x65, 0x69, 0x76, 0x65, 0x20,
916 0x6b, 0x65, 0x79, 0x3b, 0x20, 0x6f, 0x6e, 0x20, 0x74, 0x68,
917 0x65, 0x20, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x73,
918 0x69, 0x64, 0x65, 0x2c, 0x20, 0x69, 0x74, 0x20, 0x69, 0x73,
919 0x20, 0x74, 0x68, 0x65, 0x20, 0x73, 0x65, 0x6e, 0x64, 0x20,
920 0x6b, 0x65, 0x79, 0x2e };
923 static void mppe_GetMasterKey(uint8_t *nt_hashhash,uint8_t *nt_response,
930 SHA1Update(&Context,nt_hashhash,16);
931 SHA1Update(&Context,nt_response,24);
932 SHA1Update(&Context,magic1,27);
933 SHA1Final(digest,&Context);
935 memcpy(masterkey,digest,16);
939 static void mppe_GetAsymmetricStartKey(uint8_t *masterkey,uint8_t *sesskey,
940 int keylen,int issend)
955 SHA1Update(&Context,masterkey,16);
956 SHA1Update(&Context,SHSpad1,40);
957 SHA1Update(&Context,s,84);
958 SHA1Update(&Context,SHSpad2,40);
959 SHA1Final(digest,&Context);
961 memcpy(sesskey,digest,keylen);
965 static void mppe_chap2_get_keys128(uint8_t *nt_hashhash,uint8_t *nt_response,
966 uint8_t *sendkey,uint8_t *recvkey)
968 uint8_t masterkey[16];
970 mppe_GetMasterKey(nt_hashhash,nt_response,masterkey);
972 mppe_GetAsymmetricStartKey(masterkey,sendkey,16,1);
973 mppe_GetAsymmetricStartKey(masterkey,recvkey,16,0);
977 * Generate MPPE keys.
979 static void mppe_chap2_gen_keys128(uint8_t *nt_hashhash,uint8_t *response,
980 uint8_t *sendkey,uint8_t *recvkey)
985 mppe_chap2_get_keys128(nt_hashhash,response,enckey1,enckey2);
988 * dictionary.microsoft defines these attributes as
989 * 'encrypt=2'. The functions in src/lib/radius.c will
990 * take care of encrypting/decrypting them as appropriate,
991 * so that we don't have to.
993 memcpy (sendkey, enckey1, 16);
994 memcpy (recvkey, enckey2, 16);
999 * mschap_authorize() - authorize user if we can authenticate
1000 * it later. Add Auth-Type attribute if present in module
1001 * configuration (usually Auth-Type must be "MS-CHAP")
1003 static int mschap_authorize(void * instance, REQUEST *request)
1005 #define inst ((rlm_mschap_t *)instance)
1006 VALUE_PAIR *challenge = NULL;
1007 VALUE_PAIR *response = NULL;
1010 challenge = pairfind(request->packet->vps, PW_MSCHAP_CHALLENGE);
1012 return RLM_MODULE_NOOP;
1015 response = pairfind(request->packet->vps, PW_MSCHAP_RESPONSE);
1017 response = pairfind(request->packet->vps, PW_MSCHAP2_RESPONSE);
1020 * Nothing we recognize. Don't do anything.
1023 DEBUG2(" rlm_mschap: Found MS-CHAP-Challenge, but no MS-CHAP-Response.");
1024 return RLM_MODULE_NOOP;
1027 DEBUG2(" rlm_mschap: Found MS-CHAP attributes. Setting 'Auth-Type = %s'", inst->xlat_name);
1030 * Set Auth-Type to MS-CHAP. The authentication code
1031 * will take care of turning clear-text passwords into
1034 vp = pairmake("Auth-Type", inst->auth_type, T_OP_EQ);
1035 if (!vp) return RLM_MODULE_FAIL;
1036 pairmove(&request->config_items, &vp);
1037 pairfree(&vp); /* may be NULL */
1039 return RLM_MODULE_OK;
1044 * mschap_authenticate() - authenticate user based on given
1045 * attributes and configuration.
1046 * We will try to find out password in configuration
1047 * or in configured passwd file.
1048 * If one is found we will check paraneters given by NAS.
1050 * If PW_SMB_ACCOUNT_CTRL is not set to ACB_PWNOTREQ we must have
1052 * PAP: PW_PASSWORD or
1053 * MS-CHAP: PW_MSCHAP_CHALLENGE and PW_MSCHAP_RESPONSE or
1054 * MS-CHAP2: PW_MSCHAP_CHALLENGE and PW_MSCHAP2_RESPONSE
1055 * In case of password mismatch or locked account we MAY return
1056 * PW_MSCHAP_ERROR for MS-CHAP or MS-CHAP v2
1057 * If MS-CHAP2 succeeds we MUST return
1058 * PW_MSCHAP2_SUCCESS
1060 static int mschap_authenticate(void * instance, REQUEST *request)
1062 #define inst ((rlm_mschap_t *)instance)
1063 VALUE_PAIR *challenge = NULL;
1064 VALUE_PAIR *response = NULL;
1065 VALUE_PAIR *password = NULL;
1066 VALUE_PAIR *lm_password, *nt_password, *smb_ctrl;
1067 VALUE_PAIR *username;
1068 VALUE_PAIR *reply_attr;
1069 uint8_t nthashhash[16];
1070 uint8_t msch2resp[42];
1071 char *username_string;
1075 * Find the SMB-Account-Ctrl attribute, or the
1076 * SMB-Account-Ctrl-Text attribute.
1078 smb_ctrl = pairfind(request->config_items, PW_SMB_ACCOUNT_CTRL);
1080 password = pairfind(request->config_items,
1081 PW_SMB_ACCOUNT_CTRL_TEXT);
1083 smb_ctrl = pairmake("SMB-Account-CTRL", "0", T_OP_SET);
1084 pairadd(&request->config_items, smb_ctrl);
1085 smb_ctrl->lvalue = pdb_decode_acct_ctrl(password->strvalue);
1090 * We're configured to do MS-CHAP authentication.
1091 * and account control information exists. Enforce it.
1095 * Password is not required.
1097 if ((smb_ctrl->lvalue & ACB_PWNOTREQ) != 0) {
1098 DEBUG2(" rlm_mschap: SMB-Account-Ctrl says no password is required.");
1099 return RLM_MODULE_OK;
1104 * Decide how to get the passwords.
1106 password = pairfind(request->config_items, PW_PASSWORD);
1109 * We need an LM-Password.
1111 lm_password = pairfind(request->config_items, PW_LM_PASSWORD);
1116 if ((lm_password->length == 16) ||
1117 ((lm_password->length == 32) &&
1118 (hex2bin(lm_password->strvalue,
1119 lm_password->strvalue, 16) == 16))) {
1120 DEBUG2(" rlm_mschap: Found LM-Password");
1121 lm_password->length = 16;
1124 radlog(L_ERR, "rlm_mschap: Invalid LM-Password");
1128 } else if (!password) {
1129 DEBUG2(" rlm_mschap: No User-Password configured. Cannot create LM-Password.");
1131 } else { /* there is a configured User-Password */
1132 lm_password = pairmake("LM-Password", "", T_OP_EQ);
1134 radlog(L_ERR, "No memory");
1136 smbdes_lmpwdhash(password->strvalue,
1137 lm_password->strvalue);
1138 lm_password->length = 16;
1139 pairadd(&request->config_items, lm_password);
1144 * We need an NT-Password.
1146 nt_password = pairfind(request->config_items, PW_NT_PASSWORD);
1148 if ((nt_password->length == 16) ||
1149 ((nt_password->length == 32) &&
1150 (hex2bin(nt_password->strvalue,
1151 nt_password->strvalue, 16) == 16))) {
1152 DEBUG2(" rlm_mschap: Found NT-Password");
1153 nt_password->length = 16;
1156 radlog(L_ERR, "rlm_mschap: Invalid NT-Password");
1159 } else if (!password) {
1160 DEBUG2(" rlm_mschap: No User-Password configured. Cannot create NT-Password.");
1162 } else { /* there is a configured User-Password */
1163 nt_password = pairmake("NT-Password", "", T_OP_EQ);
1165 radlog(L_ERR, "No memory");
1166 return RLM_MODULE_FAIL;
1168 ntpwdhash(nt_password->strvalue, password->strvalue);
1169 nt_password->length = 16;
1170 pairadd(&request->config_items, nt_password);
1174 challenge = pairfind(request->packet->vps, PW_MSCHAP_CHALLENGE);
1176 DEBUG2(" rlm_mschap: No MS-CHAP-Challenge in the request");
1177 return RLM_MODULE_REJECT;
1181 * We also require an MS-CHAP-Response.
1183 response = pairfind(request->packet->vps, PW_MSCHAP_RESPONSE);
1186 * MS-CHAP-Response, means MS-CHAPv1
1192 * MS-CHAPv1 challenges are 8 octets.
1194 if (challenge->length < 8) {
1195 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Challenge has the wrong format.");
1196 return RLM_MODULE_INVALID;
1200 * Responses are 50 octets.
1202 if (response->length < 50) {
1203 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Response has the wrong format.");
1204 return RLM_MODULE_INVALID;
1208 * We are doing MS-CHAP. Calculate the MS-CHAP
1211 if (response->strvalue[1] & 0x01) {
1212 DEBUG2(" rlm_mschap: Told to do MS-CHAPv1 with NT-Password");
1213 password = nt_password;
1216 DEBUG2(" rlm_mschap: Told to do MS-CHAPv1 with LM-Password");
1217 password = lm_password;
1222 * Do the MS-CHAP authentication.
1224 if (do_mschap(inst, request, password, challenge->strvalue,
1225 response->strvalue + offset, nthashhash) < 0) {
1226 DEBUG2(" rlm_mschap: MS-CHAP-Response is incorrect.");
1227 add_reply(&request->reply->vps, *response->strvalue,
1228 "MS-CHAP-Error", "E=691 R=1", 9);
1229 return RLM_MODULE_REJECT;
1234 } else if ((response = pairfind(request->packet->vps, PW_MSCHAP2_RESPONSE)) != NULL) {
1235 uint8_t mschapv1_challenge[16];
1238 * MS-CHAPv2 challenges are 16 octets.
1240 if (challenge->length < 16) {
1241 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Challenge has the wrong format.");
1242 return RLM_MODULE_INVALID;
1246 * Responses are 50 octets.
1248 if (response->length < 50) {
1249 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Response has the wrong format.");
1250 return RLM_MODULE_INVALID;
1254 * We also require a User-Name
1256 username = pairfind(request->packet->vps, PW_USER_NAME);
1258 radlog(L_AUTH, "rlm_mschap: We require a User-Name for MS-CHAPv2");
1259 return RLM_MODULE_INVALID;
1264 * with_ntdomain_hack moved here
1266 if ((username_string = strchr(username->strvalue, '\\')) != NULL) {
1267 if (inst->with_ntdomain_hack) {
1270 DEBUG2(" rlm_mschap: NT Domain delimeter found, should we have enabled with_ntdomain_hack?");
1271 username_string = username->strvalue;
1274 username_string = username->strvalue;
1278 * The old "mschapv2" function has been moved to
1281 * MS-CHAPv2 takes some additional data to create an
1282 * MS-CHAPv1 challenge, and then does MS-CHAPv1.
1284 challenge_hash(response->strvalue + 2, /* peer challenge */
1285 challenge->strvalue, /* our challenge */
1286 username_string, /* user name */
1287 mschapv1_challenge); /* resulting challenge */
1289 DEBUG2(" rlm_mschap: Told to do MS-CHAPv2 for %s with NT-Password",
1292 if (do_mschap(inst, request, nt_password, mschapv1_challenge,
1293 response->strvalue + 26, nthashhash) < 0) {
1294 DEBUG2(" rlm_mschap: FAILED: MS-CHAP2-Response is incorrect");
1295 add_reply(&request->reply->vps, *response->strvalue,
1296 "MS-CHAP-Error", "E=691 R=1", 9);
1297 return RLM_MODULE_REJECT;
1301 * Get the NT-hash-hash, if necessary
1306 auth_response(username_string, /* without the domain */
1307 nthashhash, /* nt-hash-hash */
1308 response->strvalue + 26, /* peer response */
1309 response->strvalue + 2, /* peer challenge */
1310 challenge->strvalue, /* our challenge */
1311 msch2resp); /* calculated MPPE key */
1312 add_reply( &request->reply->vps, *response->strvalue,
1313 "MS-CHAP2-Success", msch2resp, 42);
1316 } else { /* Neither CHAPv1 or CHAPv2 response: die */
1317 radlog(L_AUTH, "rlm_mschap: No MS-CHAP response found");
1318 return RLM_MODULE_INVALID;
1322 * We have a CHAP response, but the account may be
1323 * disabled. Reject the user with the same error code
1324 * we use when their password is invalid.
1328 * Account is disabled.
1330 * They're found, but they don't exist, so we
1331 * return 'not found'.
1333 if (((smb_ctrl->lvalue & ACB_DISABLED) != 0) ||
1334 ((smb_ctrl->lvalue & ACB_NORMAL) == 0)) {
1335 DEBUG2(" rlm_mschap: SMB-Account-Ctrl says that the account is disabled, or is not a normal account.");
1336 add_reply( &request->reply->vps, *response->strvalue,
1337 "MS-CHAP-Error", "E=691 R=1", 9);
1338 return RLM_MODULE_NOTFOUND;
1342 * User is locked out.
1344 if ((smb_ctrl->lvalue & ACB_AUTOLOCK) != 0) {
1345 DEBUG2(" rlm_mschap: SMB-Account-Ctrl says that the account is locked out.");
1346 add_reply( &request->reply->vps, *response->strvalue,
1347 "MS-CHAP-Error", "E=647 R=0", 9);
1348 return RLM_MODULE_USERLOCK;
1352 /* now create MPPE attributes */
1353 if (inst->use_mppe) {
1354 uint8_t mppe_sendkey[34];
1355 uint8_t mppe_recvkey[34];
1358 DEBUG2("rlm_mschap: adding MS-CHAPv1 MPPE keys");
1359 memset(mppe_sendkey, 0, 32);
1361 memcpy(mppe_sendkey, lm_password->strvalue, 8);
1365 * According to RFC 2548 we
1366 * should send NT hash. But in
1367 * practice it doesn't work.
1368 * Instead, we should send nthashhash
1370 * This is an error on RFC 2548.
1373 * do_mschap cares to zero nthashhash if NT hash
1376 memcpy(mppe_sendkey + 8,
1378 mppe_add_reply(&request->reply->vps,
1379 "MS-CHAP-MPPE-Keys",
1381 } else if (chap == 2) {
1382 DEBUG2("rlm_mschap: adding MS-CHAPv2 MPPE keys");
1383 mppe_chap2_gen_keys128(nthashhash,
1384 response->strvalue + 26,
1385 mppe_sendkey, mppe_recvkey);
1387 mppe_add_reply(&request->reply->vps,
1390 mppe_add_reply(&request->reply->vps,
1395 reply_attr = pairmake("MS-MPPE-Encryption-Policy",
1396 (inst->require_encryption)? "0x00000002":"0x00000001",
1398 rad_assert(reply_attr != NULL);
1399 pairadd(&request->reply->vps, reply_attr);
1400 reply_attr = pairmake("MS-MPPE-Encryption-Types",
1401 (inst->require_strong)? "0x00000004":"0x00000006",
1403 rad_assert(reply_attr != NULL);
1404 pairadd(&request->reply->vps, reply_attr);
1406 } /* else we weren't asked to use MPPE */
1408 return RLM_MODULE_OK;
1412 module_t rlm_mschap = {
1414 RLM_TYPE_THREAD_SAFE, /* type */
1415 NULL, /* initialize */
1416 mschap_instantiate, /* instantiation */
1418 mschap_authenticate, /* authenticate */
1419 mschap_authorize, /* authorize */
1420 NULL, /* pre-accounting */
1421 NULL, /* accounting */
1422 NULL, /* checksimul */
1423 NULL, /* pre-proxy */
1424 NULL, /* post-proxy */
1425 NULL /* post-auth */
1427 mschap_detach, /* detach */