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> */
58 #include "rad_assert.h"
62 static const char rcsid[] = "$Id$";
65 /* Allowable account control bits */
66 #define ACB_DISABLED 0x0001 /* 1 = User account disabled */
67 #define ACB_HOMDIRREQ 0x0002 /* 1 = Home directory required */
68 #define ACB_PWNOTREQ 0x0004 /* 1 = User password not required */
69 #define ACB_TEMPDUP 0x0008 /* 1 = Temporary duplicate account */
70 #define ACB_NORMAL 0x0010 /* 1 = Normal user account */
71 #define ACB_MNS 0x0020 /* 1 = MNS logon user account */
72 #define ACB_DOMTRUST 0x0040 /* 1 = Interdomain trust account */
73 #define ACB_WSTRUST 0x0080 /* 1 = Workstation trust account */
74 #define ACB_SVRTRUST 0x0100 /* 1 = Server trust account */
75 #define ACB_PWNOEXP 0x0200 /* 1 = User password does not expire */
76 #define ACB_AUTOLOCK 0x0400 /* 1 = Account auto locked */
78 static int pdb_decode_acct_ctrl(const char *p)
84 * Check if the account type bits have been encoded after the
85 * NT password (in the form [NDHTUWSLXI]).
88 if (*p != '[') return 0;
90 for (p++; *p && !finished; p++) {
92 case 'N': /* 'N'o password. */
93 acct_ctrl |= ACB_PWNOTREQ;
96 case 'D': /* 'D'isabled. */
97 acct_ctrl |= ACB_DISABLED ;
100 case 'H': /* 'H'omedir required. */
101 acct_ctrl |= ACB_HOMDIRREQ;
104 case 'T': /* 'T'emp account. */
105 acct_ctrl |= ACB_TEMPDUP;
108 case 'U': /* 'U'ser account (normal). */
109 acct_ctrl |= ACB_NORMAL;
112 case 'M': /* 'M'NS logon user account. What is this? */
113 acct_ctrl |= ACB_MNS;
116 case 'W': /* 'W'orkstation account. */
117 acct_ctrl |= ACB_WSTRUST;
120 case 'S': /* 'S'erver account. */
121 acct_ctrl |= ACB_SVRTRUST;
124 case 'L': /* 'L'ocked account. */
125 acct_ctrl |= ACB_AUTOLOCK;
128 case 'X': /* No 'X'piry on password */
129 acct_ctrl |= ACB_PWNOEXP;
132 case 'I': /* 'I'nterdomain trust account. */
133 acct_ctrl |= ACB_DOMTRUST;
136 case ' ': /* ignore spaces */
154 * ntpwdhash converts Unicode password to 16-byte NT hash
157 static void ntpwdhash (unsigned char *szHash, const char *szPassword)
159 char szUnicodePass[513];
164 * NT passwords are unicode. Convert plain text password
165 * to unicode by inserting a zero every other byte
167 nPasswordLen = strlen(szPassword);
168 for (i = 0; i < nPasswordLen; i++) {
169 szUnicodePass[i << 1] = szPassword[i];
170 szUnicodePass[(i << 1) + 1] = 0;
173 /* Encrypt Unicode password to a 16-byte MD4 hash */
174 md4_calc(szHash, szUnicodePass, (nPasswordLen<<1) );
179 * challenge_hash() is used by mschap2() and auth_response()
180 * implements RFC2759 ChallengeHash()
181 * generates 64 bit challenge
183 static void challenge_hash( const uint8_t *peer_challenge,
184 const uint8_t *auth_challenge,
185 const char *user_name, uint8_t *challenge )
191 SHA1Update(&Context, peer_challenge, 16);
192 SHA1Update(&Context, auth_challenge, 16);
193 SHA1Update(&Context, user_name, strlen(user_name));
194 SHA1Final(hash, &Context);
195 memcpy(challenge, hash, 8);
199 * auth_response() generates MS-CHAP v2 SUCCESS response
200 * according to RFC 2759 GenerateAuthenticatorResponse()
201 * returns 42-octet response string
203 static void auth_response(const char *username,
204 const uint8_t *nt_hash_hash,
206 char *peer_challenge, char *auth_challenge,
210 const uint8_t magic1[39] =
211 {0x4D, 0x61, 0x67, 0x69, 0x63, 0x20, 0x73, 0x65, 0x72, 0x76,
212 0x65, 0x72, 0x20, 0x74, 0x6F, 0x20, 0x63, 0x6C, 0x69, 0x65,
213 0x6E, 0x74, 0x20, 0x73, 0x69, 0x67, 0x6E, 0x69, 0x6E, 0x67,
214 0x20, 0x63, 0x6F, 0x6E, 0x73, 0x74, 0x61, 0x6E, 0x74};
216 const uint8_t magic2[41] =
217 {0x50, 0x61, 0x64, 0x20, 0x74, 0x6F, 0x20, 0x6D, 0x61, 0x6B,
218 0x65, 0x20, 0x69, 0x74, 0x20, 0x64, 0x6F, 0x20, 0x6D, 0x6F,
219 0x72, 0x65, 0x20, 0x74, 0x68, 0x61, 0x6E, 0x20, 0x6F, 0x6E,
220 0x65, 0x20, 0x69, 0x74, 0x65, 0x72, 0x61, 0x74, 0x69, 0x6F,
227 SHA1Update(&Context, nt_hash_hash, 16);
228 SHA1Update(&Context, ntresponse, 24);
229 SHA1Update(&Context, magic1, 39);
230 SHA1Final(digest, &Context);
231 challenge_hash(peer_challenge, auth_challenge, username, challenge);
233 SHA1Update(&Context, digest, 20);
234 SHA1Update(&Context, challenge, 8);
235 SHA1Update(&Context, magic2, 41);
236 SHA1Final(digest, &Context);
239 * Encode the value of 'Digest' as "S=" followed by
240 * 40 ASCII hexadecimal digits and return it in
241 * AuthenticatorResponse.
243 * "S=0123456789ABCDEF0123456789ABCDEF01234567"
247 lrad_bin2hex(digest, response + 2, 20);
251 typedef struct rlm_mschap_t {
253 int require_encryption;
255 int with_ntdomain_hack; /* this should be in another module */
258 char *auth_type; /* I don't think this is needed... */
264 * Does dynamic translation of strings.
266 * Pulls NT-Response, LM-Response, or Challenge from MSCHAP
269 static int mschap_xlat(void *instance, REQUEST *request,
270 char *fmt, char *out, size_t outlen,
271 RADIUS_ESCAPE_STRING func)
274 uint8_t *data = NULL;
276 VALUE_PAIR *user_name;
277 VALUE_PAIR *chap_challenge, *response;
278 rlm_mschap_t *inst = instance;
280 chap_challenge = response = NULL;
282 func = func; /* -Wunused */
285 * Challenge means MS-CHAPv1 challenge, or
286 * hash of MS-CHAPv2 challenge, and peer challenge.
288 if (strcasecmp(fmt, "Challenge") == 0) {
289 chap_challenge = pairfind(request->packet->vps,
290 PW_MSCHAP_CHALLENGE);
291 if (!chap_challenge) {
292 DEBUG2(" rlm_mschap: No MS-CHAP-Challenge in the request.");
297 * MS-CHAP-Challenges are 8 octets,
300 if (chap_challenge->length == 8) {
301 DEBUG2(" mschap1: %02x",
302 chap_challenge->vp_octets[0]);
303 data = chap_challenge->vp_octets;
307 * MS-CHAP-Challenges are 16 octets,
310 } else if (chap_challenge->length == 16) {
311 char *username_string;
313 DEBUG2(" mschap2: %02x", chap_challenge->vp_octets[0]);
314 response = pairfind(request->packet->vps,
315 PW_MSCHAP2_RESPONSE);
317 DEBUG2(" rlm_mschap: MS-CHAP2-Response is required to calculate MS-CHAPv1 challenge.");
322 * Responses are 50 octets.
324 if (response->length < 50) {
325 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Response has the wrong format.");
329 user_name = pairfind(request->packet->vps,
332 DEBUG2(" rlm_mschap: User-Name is required to calculateMS-CHAPv1 Challenge.");
337 * with_ntdomain_hack moved here, too.
339 if ((username_string = strchr(user_name->vp_strvalue, '\\')) != NULL) {
340 if (inst->with_ntdomain_hack) {
343 DEBUG2(" rlm_mschap: NT Domain delimeter found, should we have enabled with_ntdomain_hack?");
344 username_string = user_name->vp_strvalue;
347 username_string = user_name->vp_strvalue;
351 * Get the MS-CHAPv1 challenge
352 * from the MS-CHAPv2 peer challenge,
353 * our challenge, and the user name.
355 challenge_hash(response->vp_octets + 2,
356 chap_challenge->vp_octets,
357 username_string, buffer);
361 DEBUG2(" rlm_mschap: Invalid MS-CHAP challenge length");
366 * Get the MS-CHAPv1 response, or the MS-CHAPv2
369 } else if (strcasecmp(fmt, "NT-Response") == 0) {
370 response = pairfind(request->packet->vps,
372 if (!response) response = pairfind(request->packet->vps,
373 PW_MSCHAP2_RESPONSE);
375 DEBUG2(" rlm_mschap: No MS-CHAP-Response or MS-CHAP2-Response was found in the request.");
380 * For MS-CHAPv1, the NT-Response exists only
381 * if the second octet says so.
383 if ((response->attribute == PW_MSCHAP_RESPONSE) &&
384 ((response->vp_octets[1] & 0x01) == 0)) {
385 DEBUG2(" rlm_mschap: No NT-Response in MS-CHAP-Response");
390 * MS-CHAP-Response and MS-CHAP2-Response have
391 * the NT-Response at the same offset, and are
394 data = response->vp_octets + 26;
398 * LM-Response is deprecated, and exists only
399 * in MS-CHAPv1, and not often there.
401 } else if (strcasecmp(fmt, "LM-Response") == 0) {
402 response = pairfind(request->packet->vps,
405 DEBUG2(" rlm_mschap: No MS-CHAP-Response was found in the request.");
410 * For MS-CHAPv1, the NT-Response exists only
411 * if the second octet says so.
413 if ((response->vp_octets[1] & 0x01) != 0) {
414 DEBUG2(" rlm_mschap: No LM-Response in MS-CHAP-Response");
417 data = response->vp_octets + 2;
421 * Pull the NT-Domain out of the User-Name, if it exists.
423 } else if (strcasecmp(fmt, "NT-Domain") == 0) {
426 user_name = pairfind(request->packet->vps, PW_USER_NAME);
428 DEBUG2(" rlm_mschap: No User-Name was found in the request.");
433 * First check to see if this is a host/ style User-Name
434 * (a la Kerberos host principal)
436 if (strncmp(user_name->vp_strvalue, "host/", 5) == 0) {
438 * If we're getting a User-Name formatted in this way,
439 * it's likely due to PEAP. The Windows Domain will be
440 * the first domain component following the hostname.
442 p = strchr(user_name->vp_strvalue, '.');
446 * use the same hack as below
449 strNcpy(out, p, outlen);
452 p = strchr(user_name->vp_strvalue, '\\');
454 DEBUG2(" rlm_mschap: No NT-Domain was found in the User-Name.");
459 * Hack. This is simpler than the alternatives.
462 strNcpy(out, user_name->vp_strvalue, outlen);
469 * Pull the User-Name out of the User-Name...
471 } else if (strcasecmp(fmt, "User-Name") == 0) {
474 user_name = pairfind(request->packet->vps, PW_USER_NAME);
476 DEBUG2(" rlm_mschap: No User-Name was found in the request.");
481 * First check to see if this is a host/ style User-Name
482 * (a la Kerberos host principal)
484 if (strncmp(user_name->vp_strvalue, "host/", 5) == 0) {
486 * If we're getting a User-Name formatted in this way,
487 * it's likely due to PEAP. When authenticating this against
488 * a Domain, Windows will expect the User-Name to be in the
489 * format of hostname$, the SAM version of the name, so we
490 * have to convert it to that here. We do so by stripping
491 * off the first 5 characters (host/), and copying everything
492 * from that point to the first period into a string and appending
495 p = strchr(user_name->vp_strvalue, '.');
497 * use the same hack as above
500 snprintf(out, outlen, "%s$", user_name->vp_strvalue + 5);
503 p = strchr(user_name->vp_strvalue, '\\');
505 p++; /* skip the backslash */
507 p = user_name->vp_strvalue; /* use the whole User-Name */
509 strNcpy(out, p, outlen);
515 * Return the NT-Hash of the passed string
517 } else if (strncasecmp(fmt, "NT-Hash ", 8) == 0) {
520 p = fmt + 8; /* 7 is the length of 'NT-Hash' */
521 if ((p == '\0') || (outlen <= 32))
523 DEBUG("rlm_mschap: NT-Hash: %s",p);
526 lrad_bin2hex(buffer, out, 16);
528 DEBUG("rlm_mschap: NT-Hash: Result: %s",out);
532 * Return the LM-Hash of the passed string
534 } else if (strncasecmp(fmt, "LM-Hash ", 8) == 0) {
537 p = fmt + 8; /* 7 is the length of 'LM-Hash' */
538 if ((p == '\0') || (outlen <= 32))
541 DEBUG("rlm_mschap: LM-Hash: %s",p);
542 smbdes_lmpwdhash(p,buffer);
543 lrad_bin2hex(buffer, out, 16);
545 DEBUG("rlm_mschap: LM-Hash: Result: %s",out);
548 DEBUG2(" rlm_mschap: Unknown expansion string \"%s\"",
553 if (outlen == 0) return 0; /* nowhere to go, don't do anything */
556 * Didn't set anything: this is bad.
559 DEBUG2(" rlm_mschap: Failed to do anything intelligent");
564 * Check the output length.
566 if (outlen < ((data_len * 2) + 1)) {
567 data_len = (outlen - 1) / 2;
573 for (i = 0; i < data_len; i++) {
574 sprintf(out + (2 * i), "%02x", data[i]);
576 out[data_len * 2] = '\0';
582 static const CONF_PARSER module_config[] = {
584 * Cache the password by default.
586 { "use_mppe", PW_TYPE_BOOLEAN,
587 offsetof(rlm_mschap_t,use_mppe), NULL, "yes" },
588 { "require_encryption", PW_TYPE_BOOLEAN,
589 offsetof(rlm_mschap_t,require_encryption), NULL, "no" },
590 { "require_strong", PW_TYPE_BOOLEAN,
591 offsetof(rlm_mschap_t,require_strong), NULL, "no" },
592 { "with_ntdomain_hack", PW_TYPE_BOOLEAN,
593 offsetof(rlm_mschap_t,with_ntdomain_hack), NULL, "no" },
594 { "passwd", PW_TYPE_STRING_PTR,
595 offsetof(rlm_mschap_t, passwd_file), NULL, NULL },
596 { "authtype", PW_TYPE_STRING_PTR,
597 offsetof(rlm_mschap_t, auth_type), NULL, NULL },
598 { "ntlm_auth", PW_TYPE_STRING_PTR,
599 offsetof(rlm_mschap_t, ntlm_auth), NULL, NULL },
601 { NULL, -1, 0, NULL, NULL } /* end the list */
605 * deinstantiate module, free all memory allocated during
606 * mschap_instantiate()
608 static int mschap_detach(void *instance){
609 #define inst ((rlm_mschap_t *)instance)
610 if (inst->passwd_file) free(inst->passwd_file);
611 if (inst->auth_type) free(inst->auth_type);
612 if (inst->ntlm_auth) free(inst->ntlm_auth);
613 if (inst->xlat_name) {
614 xlat_unregister(inst->xlat_name, mschap_xlat);
615 free(inst->xlat_name);
623 * Create instance for our module. Allocate space for
624 * instance structure and read configuration parameters
626 static int mschap_instantiate(CONF_SECTION *conf, void **instance)
628 const char *xlat_name;
631 inst = *instance = rad_malloc(sizeof(*inst));
635 memset(inst, 0, sizeof(*inst));
637 if (cf_section_parse(conf, inst, module_config) < 0) {
643 * This module used to support SMB Password files, but it
644 * made it too complicated. If the user tries to
645 * configure an SMB Password file, then die, with an
648 if (inst->passwd_file) {
649 radlog(L_ERR, "rlm_mschap: SMB password file is no longer supported in this module. Use rlm_passwd module instead");
655 * Create the dynamic translation.
657 if (cf_section_name1(conf))
658 xlat_register(cf_section_name1(conf),mschap_xlat, inst);
660 if ((xlat_name = cf_section_name2(conf)) != NULL)
661 xlat_register(xlat_name, mschap_xlat, inst);
662 if (xlat_name == NULL)
663 xlat_name = cf_section_name1(conf);
665 inst->xlat_name = strdup(xlat_name);
671 * add_reply() adds either MS-CHAP2-Success or MS-CHAP-Error
672 * attribute to reply packet
674 static void add_reply(VALUE_PAIR** vp, unsigned char ident,
675 const char* name, const char* value, int len)
677 VALUE_PAIR *reply_attr;
678 reply_attr = pairmake(name, "", T_OP_EQ);
680 DEBUG(" rlm_mschap: Failed to create attribute %s: %s\n", name, librad_errstr);
684 reply_attr->vp_octets[0] = ident;
685 memcpy(reply_attr->vp_octets + 1, value, len);
686 reply_attr->length = len + 1;
687 pairadd(vp, reply_attr);
691 * Add MPPE attributes to the reply.
693 static void mppe_add_reply(VALUE_PAIR **vp,
694 const char* name, const char* value, int len)
696 VALUE_PAIR *reply_attr;
697 reply_attr = pairmake(name, "", T_OP_EQ);
699 DEBUG("rlm_mschap: mppe_add_reply failed to create attribute %s: %s\n", name, librad_errstr);
703 memcpy(reply_attr->vp_octets, value, len);
704 reply_attr->length = len;
705 pairadd(vp, reply_attr);
710 * Do the MS-CHAP stuff.
712 * This function is here so that all of the MS-CHAP related
713 * authentication is in one place, and we can perhaps later replace
714 * it with code to call winbindd, or something similar.
716 static int do_mschap(rlm_mschap_t *inst,
717 REQUEST *request, VALUE_PAIR *password,
718 uint8_t *challenge, uint8_t *response,
721 int do_ntlm_auth = 0;
722 uint8_t calculated[24];
723 VALUE_PAIR *vp = NULL;
726 * If we have ntlm_auth configured, use it unless told
729 if (inst->ntlm_auth) do_ntlm_auth = 1;
732 * If we have an ntlm_auth configuration, then we may
735 vp = pairfind(request->config_items,
736 PW_MS_CHAP_USE_NTLM_AUTH);
737 if (vp) do_ntlm_auth = vp->lvalue;
740 * No ntlm_auth configured, attribute to tell us to
741 * use it exists, and we're told to use it. We don't
744 if (!inst->ntlm_auth && do_ntlm_auth) {
745 DEBUG2(" rlm_mschap: Asked to use ntlm_auth, but it was not configured in the mschap{} section.");
750 * Do normal authentication.
754 * No password: can't do authentication.
757 DEBUG2(" rlm_mschap: FAILED: No NT/LM-Password. Cannot perform authentication.");
761 smbdes_mschap(password->vp_strvalue, challenge, calculated);
762 if (memcmp(response, calculated, 24) != 0) {
767 * If the password exists, and is an NT-Password,
768 * then calculate the hash of the NT hash. Doing this
769 * here minimizes work for later.
771 if (password && (password->attribute == PW_NT_PASSWORD)) {
772 md4_calc(nthashhash, password->vp_strvalue, 16);
774 memset(nthashhash, 0, 16);
776 } else { /* run ntlm_auth */
780 memset(nthashhash, 0, 16);
783 * Run the program, and expect that we get 16
785 result = radius_exec_program(inst->ntlm_auth, request,
787 buffer, sizeof(buffer),
790 DEBUG2(" rlm_mschap: External script failed.");
795 * Parse the answer as an nthashhash.
797 * ntlm_auth currently returns:
798 * NT_KEY: 000102030405060708090a0b0c0d0e0f
800 if (memcmp(buffer, "NT_KEY: ", 8) != 0) {
801 DEBUG2(" rlm_mschap: Invalid output from ntlm_auth: expecting NT_KEY");
806 * Check the length. It should be at least 32,
807 * with an LF at the end.
809 if (strlen(buffer + 8) < 32) {
810 DEBUG2(" rlm_mschap: Invalid output from ntlm_auth: NT_KEY has unexpected length");
815 * Update the NT hash hash, from the NT key.
817 if (lrad_hex2bin(buffer + 8, nthashhash, 16) != 16) {
818 DEBUG2(" rlm_mschap: Invalid output from ntlm_auth: NT_KEY has non-hex values");
828 * Data for the hashes.
830 static const uint8_t SHSpad1[40] =
831 { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
832 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
833 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
834 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 };
836 static const uint8_t SHSpad2[40] =
837 { 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2,
838 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2,
839 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2,
840 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2, 0xf2 };
842 static const uint8_t magic1[27] =
843 { 0x54, 0x68, 0x69, 0x73, 0x20, 0x69, 0x73, 0x20, 0x74,
844 0x68, 0x65, 0x20, 0x4d, 0x50, 0x50, 0x45, 0x20, 0x4d,
845 0x61, 0x73, 0x74, 0x65, 0x72, 0x20, 0x4b, 0x65, 0x79 };
847 static const uint8_t magic2[84] =
848 { 0x4f, 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x63, 0x6c, 0x69,
849 0x65, 0x6e, 0x74, 0x20, 0x73, 0x69, 0x64, 0x65, 0x2c, 0x20,
850 0x74, 0x68, 0x69, 0x73, 0x20, 0x69, 0x73, 0x20, 0x74, 0x68,
851 0x65, 0x20, 0x73, 0x65, 0x6e, 0x64, 0x20, 0x6b, 0x65, 0x79,
852 0x3b, 0x20, 0x6f, 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x73,
853 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x73, 0x69, 0x64, 0x65,
854 0x2c, 0x20, 0x69, 0x74, 0x20, 0x69, 0x73, 0x20, 0x74, 0x68,
855 0x65, 0x20, 0x72, 0x65, 0x63, 0x65, 0x69, 0x76, 0x65, 0x20,
856 0x6b, 0x65, 0x79, 0x2e };
858 static const uint8_t magic3[84] =
859 { 0x4f, 0x6e, 0x20, 0x74, 0x68, 0x65, 0x20, 0x63, 0x6c, 0x69,
860 0x65, 0x6e, 0x74, 0x20, 0x73, 0x69, 0x64, 0x65, 0x2c, 0x20,
861 0x74, 0x68, 0x69, 0x73, 0x20, 0x69, 0x73, 0x20, 0x74, 0x68,
862 0x65, 0x20, 0x72, 0x65, 0x63, 0x65, 0x69, 0x76, 0x65, 0x20,
863 0x6b, 0x65, 0x79, 0x3b, 0x20, 0x6f, 0x6e, 0x20, 0x74, 0x68,
864 0x65, 0x20, 0x73, 0x65, 0x72, 0x76, 0x65, 0x72, 0x20, 0x73,
865 0x69, 0x64, 0x65, 0x2c, 0x20, 0x69, 0x74, 0x20, 0x69, 0x73,
866 0x20, 0x74, 0x68, 0x65, 0x20, 0x73, 0x65, 0x6e, 0x64, 0x20,
867 0x6b, 0x65, 0x79, 0x2e };
870 static void mppe_GetMasterKey(uint8_t *nt_hashhash,uint8_t *nt_response,
877 SHA1Update(&Context,nt_hashhash,16);
878 SHA1Update(&Context,nt_response,24);
879 SHA1Update(&Context,magic1,27);
880 SHA1Final(digest,&Context);
882 memcpy(masterkey,digest,16);
886 static void mppe_GetAsymmetricStartKey(uint8_t *masterkey,uint8_t *sesskey,
887 int keylen,int issend)
902 SHA1Update(&Context,masterkey,16);
903 SHA1Update(&Context,SHSpad1,40);
904 SHA1Update(&Context,s,84);
905 SHA1Update(&Context,SHSpad2,40);
906 SHA1Final(digest,&Context);
908 memcpy(sesskey,digest,keylen);
912 static void mppe_chap2_get_keys128(uint8_t *nt_hashhash,uint8_t *nt_response,
913 uint8_t *sendkey,uint8_t *recvkey)
915 uint8_t masterkey[16];
917 mppe_GetMasterKey(nt_hashhash,nt_response,masterkey);
919 mppe_GetAsymmetricStartKey(masterkey,sendkey,16,1);
920 mppe_GetAsymmetricStartKey(masterkey,recvkey,16,0);
924 * Generate MPPE keys.
926 static void mppe_chap2_gen_keys128(uint8_t *nt_hashhash,uint8_t *response,
927 uint8_t *sendkey,uint8_t *recvkey)
932 mppe_chap2_get_keys128(nt_hashhash,response,enckey1,enckey2);
935 * dictionary.microsoft defines these attributes as
936 * 'encrypt=2'. The functions in src/lib/radius.c will
937 * take care of encrypting/decrypting them as appropriate,
938 * so that we don't have to.
940 memcpy (sendkey, enckey1, 16);
941 memcpy (recvkey, enckey2, 16);
946 * mschap_authorize() - authorize user if we can authenticate
947 * it later. Add Auth-Type attribute if present in module
948 * configuration (usually Auth-Type must be "MS-CHAP")
950 static int mschap_authorize(void * instance, REQUEST *request)
952 #define inst ((rlm_mschap_t *)instance)
953 VALUE_PAIR *challenge = NULL, *response = NULL;
955 const char *authtype_name = "MS-CHAP";
957 challenge = pairfind(request->packet->vps, PW_MSCHAP_CHALLENGE);
959 return RLM_MODULE_NOOP;
962 response = pairfind(request->packet->vps, PW_MSCHAP_RESPONSE);
964 response = pairfind(request->packet->vps, PW_MSCHAP2_RESPONSE);
967 * Nothing we recognize. Don't do anything.
970 DEBUG2(" rlm_mschap: Found MS-CHAP-Challenge, but no MS-CHAP-Response.");
971 return RLM_MODULE_NOOP;
975 * Choose MS-CHAP, or whatever else they told us to use.
977 if (inst->auth_type) {
978 authtype_name = inst->auth_type;
981 DEBUG2(" rlm_mschap: Found MS-CHAP attributes. Setting 'Auth-Type = %s'", authtype_name);
984 * Set Auth-Type to MS-CHAP. The authentication code
985 * will take care of turning clear-text passwords into
988 pairdelete(&request->config_items, PW_AUTHTYPE);
989 vp = pairmake("Auth-Type", authtype_name, T_OP_EQ);
990 rad_assert(vp != NULL);
991 pairadd(&request->config_items, vp);
993 return RLM_MODULE_OK;
998 * mschap_authenticate() - authenticate user based on given
999 * attributes and configuration.
1000 * We will try to find out password in configuration
1001 * or in configured passwd file.
1002 * If one is found we will check paraneters given by NAS.
1004 * If PW_SMB_ACCOUNT_CTRL is not set to ACB_PWNOTREQ we must have
1006 * PAP: PW_PASSWORD or
1007 * MS-CHAP: PW_MSCHAP_CHALLENGE and PW_MSCHAP_RESPONSE or
1008 * MS-CHAP2: PW_MSCHAP_CHALLENGE and PW_MSCHAP2_RESPONSE
1009 * In case of password mismatch or locked account we MAY return
1010 * PW_MSCHAP_ERROR for MS-CHAP or MS-CHAP v2
1011 * If MS-CHAP2 succeeds we MUST return
1012 * PW_MSCHAP2_SUCCESS
1014 static int mschap_authenticate(void * instance, REQUEST *request)
1016 #define inst ((rlm_mschap_t *)instance)
1017 VALUE_PAIR *challenge = NULL;
1018 VALUE_PAIR *response = NULL;
1019 VALUE_PAIR *password = NULL;
1020 VALUE_PAIR *lm_password, *nt_password, *smb_ctrl;
1021 VALUE_PAIR *username;
1022 VALUE_PAIR *reply_attr;
1023 uint8_t nthashhash[16];
1024 uint8_t msch2resp[42];
1025 char *username_string;
1029 * Find the SMB-Account-Ctrl attribute, or the
1030 * SMB-Account-Ctrl-Text attribute.
1032 smb_ctrl = pairfind(request->config_items, PW_SMB_ACCOUNT_CTRL);
1034 password = pairfind(request->config_items,
1035 PW_SMB_ACCOUNT_CTRL_TEXT);
1037 smb_ctrl = pairmake("SMB-Account-CTRL", "0", T_OP_SET);
1038 pairadd(&request->config_items, smb_ctrl);
1039 smb_ctrl->lvalue = pdb_decode_acct_ctrl(password->vp_strvalue);
1044 * We're configured to do MS-CHAP authentication.
1045 * and account control information exists. Enforce it.
1049 * Password is not required.
1051 if ((smb_ctrl->lvalue & ACB_PWNOTREQ) != 0) {
1052 DEBUG2(" rlm_mschap: SMB-Account-Ctrl says no password is required.");
1053 return RLM_MODULE_OK;
1058 * Decide how to get the passwords.
1060 password = pairfind(request->config_items, PW_PASSWORD);
1063 * We need an LM-Password.
1065 lm_password = pairfind(request->config_items, PW_LM_PASSWORD);
1070 if ((lm_password->length == 16) ||
1071 ((lm_password->length == 32) &&
1072 (lrad_hex2bin(lm_password->vp_strvalue,
1073 lm_password->vp_strvalue, 16) == 16))) {
1074 DEBUG2(" rlm_mschap: Found LM-Password");
1075 lm_password->length = 16;
1078 radlog(L_ERR, "rlm_mschap: Invalid LM-Password");
1082 } else if (!password) {
1083 DEBUG2(" rlm_mschap: No User-Password configured. Cannot create LM-Password.");
1085 } else { /* there is a configured User-Password */
1086 lm_password = pairmake("LM-Password", "", T_OP_EQ);
1088 radlog(L_ERR, "No memory");
1090 smbdes_lmpwdhash(password->vp_strvalue,
1091 lm_password->vp_strvalue);
1092 lm_password->length = 16;
1093 pairadd(&request->config_items, lm_password);
1098 * We need an NT-Password.
1100 nt_password = pairfind(request->config_items, PW_NT_PASSWORD);
1102 if ((nt_password->length == 16) ||
1103 ((nt_password->length == 32) &&
1104 (lrad_hex2bin(nt_password->vp_strvalue,
1105 nt_password->vp_strvalue, 16) == 16))) {
1106 DEBUG2(" rlm_mschap: Found NT-Password");
1107 nt_password->length = 16;
1110 radlog(L_ERR, "rlm_mschap: Invalid NT-Password");
1113 } else if (!password) {
1114 DEBUG2(" rlm_mschap: No User-Password configured. Cannot create NT-Password.");
1116 } else { /* there is a configured User-Password */
1117 nt_password = pairmake("NT-Password", "", T_OP_EQ);
1119 radlog(L_ERR, "No memory");
1120 return RLM_MODULE_FAIL;
1122 ntpwdhash(nt_password->vp_strvalue,
1123 password->vp_strvalue);
1124 nt_password->length = 16;
1125 pairadd(&request->config_items, nt_password);
1129 challenge = pairfind(request->packet->vps, PW_MSCHAP_CHALLENGE);
1131 DEBUG2(" rlm_mschap: No MS-CHAP-Challenge in the request");
1132 return RLM_MODULE_REJECT;
1136 * We also require an MS-CHAP-Response.
1138 response = pairfind(request->packet->vps, PW_MSCHAP_RESPONSE);
1141 * MS-CHAP-Response, means MS-CHAPv1
1147 * MS-CHAPv1 challenges are 8 octets.
1149 if (challenge->length < 8) {
1150 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Challenge has the wrong format.");
1151 return RLM_MODULE_INVALID;
1155 * Responses are 50 octets.
1157 if (response->length < 50) {
1158 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Response has the wrong format.");
1159 return RLM_MODULE_INVALID;
1163 * We are doing MS-CHAP. Calculate the MS-CHAP
1166 if (response->vp_octets[1] & 0x01) {
1167 DEBUG2(" rlm_mschap: Told to do MS-CHAPv1 with NT-Password");
1168 password = nt_password;
1171 DEBUG2(" rlm_mschap: Told to do MS-CHAPv1 with LM-Password");
1172 password = lm_password;
1177 * Do the MS-CHAP authentication.
1179 if (do_mschap(inst, request, password, challenge->vp_octets,
1180 response->vp_octets + offset, nthashhash) < 0) {
1181 DEBUG2(" rlm_mschap: MS-CHAP-Response is incorrect.");
1182 add_reply(&request->reply->vps, *response->vp_octets,
1183 "MS-CHAP-Error", "E=691 R=1", 9);
1184 return RLM_MODULE_REJECT;
1189 } else if ((response = pairfind(request->packet->vps, PW_MSCHAP2_RESPONSE)) != NULL) {
1190 uint8_t mschapv1_challenge[16];
1193 * MS-CHAPv2 challenges are 16 octets.
1195 if (challenge->length < 16) {
1196 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Challenge has the wrong format.");
1197 return RLM_MODULE_INVALID;
1201 * Responses are 50 octets.
1203 if (response->length < 50) {
1204 radlog(L_AUTH, "rlm_mschap: MS-CHAP-Response has the wrong format.");
1205 return RLM_MODULE_INVALID;
1209 * We also require a User-Name
1211 username = pairfind(request->packet->vps, PW_USER_NAME);
1213 radlog(L_AUTH, "rlm_mschap: We require a User-Name for MS-CHAPv2");
1214 return RLM_MODULE_INVALID;
1219 * with_ntdomain_hack moved here
1221 if ((username_string = strchr(username->vp_strvalue, '\\')) != NULL) {
1222 if (inst->with_ntdomain_hack) {
1225 DEBUG2(" rlm_mschap: NT Domain delimeter found, should we have enabled with_ntdomain_hack?");
1226 username_string = username->vp_strvalue;
1229 username_string = username->vp_strvalue;
1233 * The old "mschapv2" function has been moved to
1236 * MS-CHAPv2 takes some additional data to create an
1237 * MS-CHAPv1 challenge, and then does MS-CHAPv1.
1239 challenge_hash(response->vp_octets + 2, /* peer challenge */
1240 challenge->vp_octets, /* our challenge */
1241 username_string, /* user name */
1242 mschapv1_challenge); /* resulting challenge */
1244 DEBUG2(" rlm_mschap: Told to do MS-CHAPv2 for %s with NT-Password",
1247 if (do_mschap(inst, request, nt_password, mschapv1_challenge,
1248 response->vp_octets + 26, nthashhash) < 0) {
1249 DEBUG2(" rlm_mschap: FAILED: MS-CHAP2-Response is incorrect");
1250 add_reply(&request->reply->vps, *response->vp_octets,
1251 "MS-CHAP-Error", "E=691 R=1", 9);
1252 return RLM_MODULE_REJECT;
1256 * Get the NT-hash-hash, if necessary
1261 auth_response(username_string, /* without the domain */
1262 nthashhash, /* nt-hash-hash */
1263 response->vp_octets + 26, /* peer response */
1264 response->vp_octets + 2, /* peer challenge */
1265 challenge->vp_octets, /* our challenge */
1266 msch2resp); /* calculated MPPE key */
1267 add_reply( &request->reply->vps, *response->vp_octets,
1268 "MS-CHAP2-Success", msch2resp, 42);
1271 } else { /* Neither CHAPv1 or CHAPv2 response: die */
1272 radlog(L_AUTH, "rlm_mschap: No MS-CHAP response found");
1273 return RLM_MODULE_INVALID;
1277 * We have a CHAP response, but the account may be
1278 * disabled. Reject the user with the same error code
1279 * we use when their password is invalid.
1283 * Account is disabled.
1285 * They're found, but they don't exist, so we
1286 * return 'not found'.
1288 if (((smb_ctrl->lvalue & ACB_DISABLED) != 0) ||
1289 ((smb_ctrl->lvalue & ACB_NORMAL) == 0)) {
1290 DEBUG2(" rlm_mschap: SMB-Account-Ctrl says that the account is disabled, or is not a normal account.");
1291 add_reply( &request->reply->vps, *response->vp_octets,
1292 "MS-CHAP-Error", "E=691 R=1", 9);
1293 return RLM_MODULE_NOTFOUND;
1297 * User is locked out.
1299 if ((smb_ctrl->lvalue & ACB_AUTOLOCK) != 0) {
1300 DEBUG2(" rlm_mschap: SMB-Account-Ctrl says that the account is locked out.");
1301 add_reply( &request->reply->vps, *response->vp_octets,
1302 "MS-CHAP-Error", "E=647 R=0", 9);
1303 return RLM_MODULE_USERLOCK;
1307 /* now create MPPE attributes */
1308 if (inst->use_mppe) {
1309 uint8_t mppe_sendkey[34];
1310 uint8_t mppe_recvkey[34];
1313 DEBUG2("rlm_mschap: adding MS-CHAPv1 MPPE keys");
1314 memset(mppe_sendkey, 0, 32);
1316 memcpy(mppe_sendkey, lm_password->vp_octets, 8);
1320 * According to RFC 2548 we
1321 * should send NT hash. But in
1322 * practice it doesn't work.
1323 * Instead, we should send nthashhash
1325 * This is an error on RFC 2548.
1328 * do_mschap cares to zero nthashhash if NT hash
1331 memcpy(mppe_sendkey + 8,
1333 mppe_add_reply(&request->reply->vps,
1334 "MS-CHAP-MPPE-Keys",
1336 } else if (chap == 2) {
1337 DEBUG2("rlm_mschap: adding MS-CHAPv2 MPPE keys");
1338 mppe_chap2_gen_keys128(nthashhash,
1339 response->vp_octets + 26,
1340 mppe_sendkey, mppe_recvkey);
1342 mppe_add_reply(&request->reply->vps,
1345 mppe_add_reply(&request->reply->vps,
1350 reply_attr = pairmake("MS-MPPE-Encryption-Policy",
1351 (inst->require_encryption)? "0x00000002":"0x00000001",
1353 rad_assert(reply_attr != NULL);
1354 pairadd(&request->reply->vps, reply_attr);
1355 reply_attr = pairmake("MS-MPPE-Encryption-Types",
1356 (inst->require_strong)? "0x00000004":"0x00000006",
1358 rad_assert(reply_attr != NULL);
1359 pairadd(&request->reply->vps, reply_attr);
1361 } /* else we weren't asked to use MPPE */
1363 return RLM_MODULE_OK;
1367 module_t rlm_mschap = {
1370 RLM_TYPE_THREAD_SAFE, /* type */
1371 mschap_instantiate, /* instantiation */
1372 mschap_detach, /* detach */
1374 mschap_authenticate, /* authenticate */
1375 mschap_authorize, /* authorize */
1376 NULL, /* pre-accounting */
1377 NULL, /* accounting */
1378 NULL, /* checksimul */
1379 NULL, /* pre-proxy */
1380 NULL, /* post-proxy */
1381 NULL /* post-auth */