2 * Copyright (c) 2011, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of JANET(UK) nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * Utility routines for credential handles.
37 #include "gssapiP_eap.h"
40 # include <shlobj.h> /* may need to use ShFolder.h instead */
47 gssEapAllocCred(OM_uint32 *minor, gss_cred_id_t *pCred)
52 *pCred = GSS_C_NO_CREDENTIAL;
54 cred = (gss_cred_id_t)GSSEAP_CALLOC(1, sizeof(*cred));
60 if (GSSEAP_MUTEX_INIT(&cred->mutex) != 0) {
61 *minor = GSSEAP_GET_LAST_ERROR();
62 gssEapReleaseCred(&tmpMinor, &cred);
69 return GSS_S_COMPLETE;
73 zeroAndReleasePassword(gss_buffer_t password)
75 if (password->value != NULL) {
76 memset(password->value, 0, password->length);
77 GSSEAP_FREE(password->value);
80 password->value = NULL;
85 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred)
88 gss_cred_id_t cred = *pCred;
89 krb5_context krbContext = NULL;
91 if (cred == GSS_C_NO_CREDENTIAL) {
92 return GSS_S_COMPLETE;
95 GSSEAP_KRB_INIT(&krbContext);
97 gssEapReleaseName(&tmpMinor, &cred->name);
98 gssEapReleaseName(&tmpMinor, &cred->target);
100 zeroAndReleasePassword(&cred->password);
102 gss_release_buffer(&tmpMinor, &cred->radiusConfigFile);
103 gss_release_buffer(&tmpMinor, &cred->radiusConfigStanza);
104 gss_release_buffer(&tmpMinor, &cred->caCertificate);
105 gss_release_buffer(&tmpMinor, &cred->subjectNameConstraint);
106 gss_release_buffer(&tmpMinor, &cred->subjectAltNameConstraint);
108 #ifdef GSSEAP_ENABLE_REAUTH
109 if (cred->krbCredCache != NULL) {
110 if (cred->flags & CRED_FLAG_DEFAULT_CCACHE)
111 krb5_cc_close(krbContext, cred->krbCredCache);
113 krb5_cc_destroy(krbContext, cred->krbCredCache);
115 if (cred->reauthCred != GSS_C_NO_CREDENTIAL)
116 gssReleaseCred(&tmpMinor, &cred->reauthCred);
119 GSSEAP_MUTEX_DESTROY(&cred->mutex);
120 memset(cred, 0, sizeof(*cred));
125 return GSS_S_COMPLETE;
129 readStaticIdentityFile(OM_uint32 *minor,
130 gss_buffer_t defaultIdentity,
131 gss_buffer_t defaultPassword)
133 OM_uint32 major, tmpMinor;
139 struct passwd *pw = NULL, pwd;
143 defaultIdentity->length = 0;
144 defaultIdentity->value = NULL;
146 if (defaultPassword != GSS_C_NO_BUFFER) {
147 defaultPassword->length = 0;
148 defaultPassword->value = NULL;
151 ccacheName = getenv("GSSEAP_IDENTITY");
152 if (ccacheName == NULL) {
154 TCHAR szPath[MAX_PATH];
156 if (!SUCCEEDED(SHGetFolderPath(NULL,
157 CSIDL_APPDATA, /* |CSIDL_FLAG_CREATE */
158 NULL, /* User access token */
159 0, /* SHGFP_TYPE_CURRENT */
161 major = GSS_S_CRED_UNAVAIL;
162 *minor = GSSEAP_GET_LAST_ERROR(); /* XXX */
166 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", szPath);
168 if (getpwuid_r(getuid(), &pwd, pwbuf, sizeof(pwbuf), &pw) != 0 ||
169 pw == NULL || pw->pw_dir == NULL) {
170 major = GSS_S_CRED_UNAVAIL;
171 *minor = GSSEAP_GET_LAST_ERROR();
175 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", pw->pw_dir);
180 fp = fopen(ccacheName, "r");
182 major = GSS_S_CRED_UNAVAIL;
183 *minor = GSSEAP_NO_DEFAULT_CRED;
187 while (fgets(buf, sizeof(buf), fp) != NULL) {
188 gss_buffer_desc src, *dst;
190 src.length = strlen(buf);
196 if (buf[src.length - 1] == '\n') {
197 buf[src.length - 1] = '\0';
198 if (--src.length == 0)
203 dst = defaultIdentity;
205 dst = defaultPassword;
209 if (dst != GSS_C_NO_BUFFER) {
210 major = duplicateBuffer(minor, &src, dst);
211 if (GSS_ERROR(major))
218 if (defaultIdentity->length == 0) {
219 major = GSS_S_CRED_UNAVAIL;
220 *minor = GSSEAP_NO_DEFAULT_CRED;
224 major = GSS_S_COMPLETE;
231 if (GSS_ERROR(major)) {
232 gss_release_buffer(&tmpMinor, defaultIdentity);
233 zeroAndReleasePassword(defaultPassword);
236 memset(buf, 0, sizeof(buf));
242 gssEapPrimaryMechForCred(gss_cred_id_t cred)
244 gss_OID nameMech = GSS_C_NO_OID;
246 if (cred->mechanisms != GSS_C_NO_OID_SET &&
247 cred->mechanisms->count == 1)
248 nameMech = &cred->mechanisms->elements[0];
254 gssEapAcquireCred(OM_uint32 *minor,
255 const gss_name_t desiredName,
256 OM_uint32 timeReq GSSEAP_UNUSED,
257 const gss_OID_set desiredMechs,
259 gss_cred_id_t *pCred,
260 gss_OID_set *pActualMechs,
263 OM_uint32 major, tmpMinor;
266 /* XXX TODO validate with changed set_cred_option API */
267 *pCred = GSS_C_NO_CREDENTIAL;
269 major = gssEapAllocCred(minor, &cred);
270 if (GSS_ERROR(major))
275 cred->flags |= CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT;
278 cred->flags |= CRED_FLAG_INITIATE;
281 cred->flags |= CRED_FLAG_ACCEPT;
284 major = GSS_S_FAILURE;
285 *minor = GSSEAP_BAD_USAGE;
290 major = gssEapValidateMechs(minor, desiredMechs);
291 if (GSS_ERROR(major))
294 major = duplicateOidSet(minor, desiredMechs, &cred->mechanisms);
295 if (GSS_ERROR(major))
298 if (desiredName != GSS_C_NO_NAME) {
299 GSSEAP_MUTEX_LOCK(&desiredName->mutex);
301 major = gssEapDuplicateName(minor, desiredName, &cred->name);
302 if (GSS_ERROR(major)) {
303 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
307 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
310 #ifdef GSSEAP_ENABLE_ACCEPTOR
311 if (cred->flags & CRED_FLAG_ACCEPT) {
312 struct rs_context *radContext;
314 major = gssEapCreateRadiusContext(minor, cred, &radContext);
315 if (GSS_ERROR(major))
318 rs_context_destroy(radContext);
322 if (pActualMechs != NULL) {
323 major = duplicateOidSet(minor, cred->mechanisms, pActualMechs);
324 if (GSS_ERROR(major))
329 *timeRec = GSS_C_INDEFINITE;
333 major = GSS_S_COMPLETE;
337 if (GSS_ERROR(major))
338 gssEapReleaseCred(&tmpMinor, &cred);
344 * Return TRUE if cred available for mechanism. Caller need no acquire
345 * lock because mechanisms list is immutable.
348 gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech)
353 GSSEAP_ASSERT(mech != GSS_C_NO_OID);
355 if (cred == GSS_C_NO_CREDENTIAL || cred->mechanisms == GSS_C_NO_OID_SET)
358 gss_test_oid_set_member(&minor, mech, cred->mechanisms, &present);
364 staticIdentityFileResolveDefaultIdentity(OM_uint32 *minor,
365 const gss_cred_id_t cred,
368 OM_uint32 major, tmpMinor;
369 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
370 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
372 *pName = GSS_C_NO_NAME;
374 major = readStaticIdentityFile(minor, &defaultIdentity, GSS_C_NO_BUFFER);
375 if (major == GSS_S_COMPLETE) {
376 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
380 gss_release_buffer(&tmpMinor, &defaultIdentity);
386 gssEapResolveCredIdentity(OM_uint32 *minor,
390 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
392 if (cred->name != GSS_C_NO_NAME) {
394 return GSS_S_COMPLETE;
397 if (cred->flags & CRED_FLAG_ACCEPT) {
398 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
399 char serviceName[5 + MAXHOSTNAMELEN];
401 /* default host-based service is host@localhost */
402 memcpy(serviceName, "host@", 5);
403 if (gethostname(&serviceName[5], MAXHOSTNAMELEN) != 0) {
404 *minor = GSSEAP_NO_HOSTNAME;
405 return GSS_S_FAILURE;
408 nameBuf.value = serviceName;
409 nameBuf.length = strlen((char *)nameBuf.value);
411 major = gssEapImportName(minor, &nameBuf, GSS_C_NT_HOSTBASED_SERVICE,
412 nameMech, &cred->name);
413 if (GSS_ERROR(major))
415 } else if (cred->flags & CRED_FLAG_INITIATE) {
416 #ifdef HAVE_MOONSHOT_GET_IDENTITY
417 major = libMoonshotResolveDefaultIdentity(minor, cred, &cred->name);
418 if (major == GSS_S_CRED_UNAVAIL)
420 major = staticIdentityFileResolveDefaultIdentity(minor, cred, &cred->name);
421 if (major != GSS_S_CRED_UNAVAIL)
426 return GSS_S_COMPLETE;
430 gssEapInquireCred(OM_uint32 *minor,
433 OM_uint32 *pLifetime,
434 gss_cred_usage_t *cred_usage,
435 gss_OID_set *mechanisms)
438 time_t now, lifetime;
441 major = gssEapResolveCredIdentity(minor, cred);
442 if (GSS_ERROR(major))
445 if (cred->name != GSS_C_NO_NAME) {
446 major = gssEapDuplicateName(minor, cred->name, name);
447 if (GSS_ERROR(major))
450 *name = GSS_C_NO_NAME;
453 if (cred_usage != NULL) {
454 OM_uint32 flags = (cred->flags & (CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT));
457 case CRED_FLAG_INITIATE:
458 *cred_usage = GSS_C_INITIATE;
460 case CRED_FLAG_ACCEPT:
461 *cred_usage = GSS_C_ACCEPT;
464 *cred_usage = GSS_C_BOTH;
469 if (mechanisms != NULL) {
470 if (cred->mechanisms != GSS_C_NO_OID_SET)
471 major = duplicateOidSet(minor, cred->mechanisms, mechanisms);
473 major = gssEapIndicateMechs(minor, mechanisms);
474 if (GSS_ERROR(major))
478 if (cred->expiryTime == 0) {
479 lifetime = GSS_C_INDEFINITE;
482 lifetime = now - cred->expiryTime;
487 if (pLifetime != NULL) {
488 *pLifetime = lifetime;
492 major = GSS_S_CREDENTIALS_EXPIRED;
493 *minor = GSSEAP_CRED_EXPIRED;
497 major = GSS_S_COMPLETE;
505 gssEapSetCredPassword(OM_uint32 *minor,
507 const gss_buffer_t password)
509 OM_uint32 major, tmpMinor;
510 gss_buffer_desc newPassword = GSS_C_EMPTY_BUFFER;
512 if (cred->flags & CRED_FLAG_RESOLVED) {
513 major = GSS_S_FAILURE;
514 *minor = GSSEAP_CRED_RESOLVED;
518 if (password != GSS_C_NO_BUFFER) {
519 major = duplicateBuffer(minor, password, &newPassword);
520 if (GSS_ERROR(major))
523 cred->flags |= CRED_FLAG_PASSWORD;
525 cred->flags &= ~(CRED_FLAG_PASSWORD);
528 gss_release_buffer(&tmpMinor, &cred->password);
529 cred->password = newPassword;
531 major = GSS_S_COMPLETE;
539 gssEapSetCredService(OM_uint32 *minor,
541 const gss_name_t target)
543 OM_uint32 major, tmpMinor;
544 gss_name_t newTarget = GSS_C_NO_NAME;
546 if (cred->flags & CRED_FLAG_RESOLVED) {
547 major = GSS_S_FAILURE;
548 *minor = GSSEAP_CRED_RESOLVED;
552 if (target != GSS_C_NO_NAME) {
553 major = gssEapDuplicateName(minor, target, &newTarget);
554 if (GSS_ERROR(major))
557 cred->flags |= CRED_FLAG_TARGET;
559 cred->flags &= ~(CRED_FLAG_TARGET);
562 gssEapReleaseName(&tmpMinor, &cred->target);
563 cred->target = newTarget;
565 major = GSS_S_COMPLETE;
573 gssEapDuplicateCred(OM_uint32 *minor,
574 const gss_cred_id_t src,
577 OM_uint32 major, tmpMinor;
578 gss_cred_id_t dst = GSS_C_NO_CREDENTIAL;
580 *pDst = GSS_C_NO_CREDENTIAL;
582 major = gssEapAllocCred(minor, &dst);
583 if (GSS_ERROR(major))
586 dst->flags = src->flags;
588 if (src->name != GSS_C_NO_NAME) {
589 major = gssEapDuplicateName(minor, src->name, &dst->name);
590 if (GSS_ERROR(major))
594 if (src->target != GSS_C_NO_NAME) {
595 major = gssEapDuplicateName(minor, src->target, &dst->target);
596 if (GSS_ERROR(major))
600 if (src->password.value != NULL) {
601 major = duplicateBuffer(minor, &src->password, &dst->password);
602 if (GSS_ERROR(major))
606 major = duplicateOidSet(minor, src->mechanisms, &dst->mechanisms);
607 if (GSS_ERROR(major))
610 dst->expiryTime = src->expiryTime;
612 if (src->radiusConfigFile.value != NULL)
613 duplicateBufferOrCleanup(&src->radiusConfigFile, &dst->radiusConfigFile);
614 if (src->radiusConfigStanza.value != NULL)
615 duplicateBufferOrCleanup(&src->radiusConfigStanza, &dst->radiusConfigStanza);
616 if (src->caCertificate.value != NULL)
617 duplicateBufferOrCleanup(&src->caCertificate, &dst->caCertificate);
618 if (src->subjectNameConstraint.value != NULL)
619 duplicateBufferOrCleanup(&src->subjectNameConstraint, &dst->subjectNameConstraint);
620 if (src->subjectAltNameConstraint.value != NULL)
621 duplicateBufferOrCleanup(&src->subjectAltNameConstraint, &dst->subjectAltNameConstraint);
623 #ifdef GSSEAP_ENABLE_REAUTH
624 /* XXX krbCredCache, reauthCred */
628 dst = GSS_C_NO_CREDENTIAL;
630 major = GSS_S_COMPLETE;
634 gssEapReleaseCred(&tmpMinor, &dst);
640 staticIdentityFileResolveInitiatorCred(OM_uint32 *minor, gss_cred_id_t cred)
642 OM_uint32 major, tmpMinor;
643 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
644 gss_name_t defaultIdentityName = GSS_C_NO_NAME;
645 gss_buffer_desc defaultPassword = GSS_C_EMPTY_BUFFER;
646 int isDefaultIdentity = FALSE;
648 major = readStaticIdentityFile(minor, &defaultIdentity, &defaultPassword);
649 if (GSS_ERROR(major))
652 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
653 gssEapPrimaryMechForCred(cred), &defaultIdentityName);
654 if (GSS_ERROR(major))
657 if (defaultIdentityName == GSS_C_NO_NAME) {
658 if (cred->name == GSS_C_NO_NAME) {
659 major = GSS_S_CRED_UNAVAIL;
660 *minor = GSSEAP_NO_DEFAULT_IDENTITY;
664 if (cred->name == GSS_C_NO_NAME) {
665 cred->name = defaultIdentityName;
666 defaultIdentityName = GSS_C_NO_NAME;
667 isDefaultIdentity = TRUE;
669 major = gssEapCompareName(minor, cred->name,
670 defaultIdentityName, &isDefaultIdentity);
671 if (GSS_ERROR(major))
676 if (isDefaultIdentity &&
677 (cred->flags & CRED_FLAG_PASSWORD) == 0) {
678 major = gssEapSetCredPassword(minor, cred, &defaultPassword);
679 if (GSS_ERROR(major))
684 gssEapReleaseName(&tmpMinor, &defaultIdentityName);
685 zeroAndReleasePassword(&defaultPassword);
686 gss_release_buffer(&tmpMinor, &defaultIdentity);
692 gssEapResolveInitiatorCred(OM_uint32 *minor,
693 const gss_cred_id_t cred,
694 const gss_name_t targetName
695 #ifndef HAVE_MOONSHOT_GET_IDENTITY
699 gss_cred_id_t *pResolvedCred)
701 OM_uint32 major, tmpMinor;
702 gss_cred_id_t resolvedCred = GSS_C_NO_CREDENTIAL;
704 if (cred == GSS_C_NO_CREDENTIAL) {
705 major = gssEapAcquireCred(minor,
713 if (GSS_ERROR(major))
716 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
717 major = GSS_S_NO_CRED;
718 *minor = GSSEAP_CRED_USAGE_MISMATCH;
722 major = gssEapDuplicateCred(minor, cred, &resolvedCred);
723 if (GSS_ERROR(major))
727 if ((resolvedCred->flags & CRED_FLAG_RESOLVED) == 0) {
728 #ifdef HAVE_MOONSHOT_GET_IDENTITY
729 major = libMoonshotResolveInitiatorCred(minor, resolvedCred, targetName);
730 if (major == GSS_S_CRED_UNAVAIL)
732 major = staticIdentityFileResolveInitiatorCred(minor, resolvedCred);
733 if (GSS_ERROR(major) && major != GSS_S_CRED_UNAVAIL)
736 /* If we have a caller-supplied password, the credential is resolved. */
737 if ((resolvedCred->flags & CRED_FLAG_PASSWORD) == 0) {
738 major = GSS_S_CRED_UNAVAIL;
739 *minor = GSSEAP_NO_DEFAULT_CRED;
743 resolvedCred->flags |= CRED_FLAG_RESOLVED;
746 *pResolvedCred = resolvedCred;
747 resolvedCred = GSS_C_NO_CREDENTIAL;
749 major = GSS_S_COMPLETE;
753 gssEapReleaseCred(&tmpMinor, &resolvedCred);