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 GSSEAP_ASSERT(password != GSS_C_NO_BUFFER);
77 if (password->value != NULL) {
78 memset(password->value, 0, password->length);
79 GSSEAP_FREE(password->value);
82 password->value = NULL;
87 gssEapReleaseCred(OM_uint32 *minor, gss_cred_id_t *pCred)
90 gss_cred_id_t cred = *pCred;
91 krb5_context krbContext = NULL;
93 if (cred == GSS_C_NO_CREDENTIAL) {
94 return GSS_S_COMPLETE;
97 GSSEAP_KRB_INIT(&krbContext);
99 gssEapReleaseName(&tmpMinor, &cred->name);
100 gssEapReleaseName(&tmpMinor, &cred->target);
102 zeroAndReleasePassword(&cred->password);
104 gss_release_buffer(&tmpMinor, &cred->radiusConfigFile);
105 gss_release_buffer(&tmpMinor, &cred->radiusConfigStanza);
106 gss_release_buffer(&tmpMinor, &cred->caCertificate);
107 gss_release_buffer(&tmpMinor, &cred->subjectNameConstraint);
108 gss_release_buffer(&tmpMinor, &cred->subjectAltNameConstraint);
109 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
110 gss_release_buffer(&tmpMinor, &cred->privateKey);
112 #ifdef GSSEAP_ENABLE_REAUTH
113 if (cred->krbCredCache != NULL) {
114 if (cred->flags & CRED_FLAG_DEFAULT_CCACHE)
115 krb5_cc_close(krbContext, cred->krbCredCache);
117 krb5_cc_destroy(krbContext, cred->krbCredCache);
119 if (cred->reauthCred != GSS_C_NO_CREDENTIAL)
120 gssReleaseCred(&tmpMinor, &cred->reauthCred);
123 GSSEAP_MUTEX_DESTROY(&cred->mutex);
124 memset(cred, 0, sizeof(*cred));
129 return GSS_S_COMPLETE;
133 readStaticIdentityFile(OM_uint32 *minor,
134 gss_buffer_t defaultIdentity,
135 gss_buffer_t defaultPassword)
137 OM_uint32 major, tmpMinor;
143 struct passwd *pw = NULL, pwd;
147 defaultIdentity->length = 0;
148 defaultIdentity->value = NULL;
150 if (defaultPassword != GSS_C_NO_BUFFER) {
151 defaultPassword->length = 0;
152 defaultPassword->value = NULL;
155 ccacheName = getenv("GSSEAP_IDENTITY");
156 if (ccacheName == NULL) {
158 TCHAR szPath[MAX_PATH];
160 if (!SUCCEEDED(SHGetFolderPath(NULL,
161 CSIDL_APPDATA, /* |CSIDL_FLAG_CREATE */
162 NULL, /* User access token */
163 0, /* SHGFP_TYPE_CURRENT */
165 major = GSS_S_CRED_UNAVAIL;
166 *minor = GSSEAP_GET_LAST_ERROR(); /* XXX */
170 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", szPath);
172 if (getpwuid_r(getuid(), &pwd, pwbuf, sizeof(pwbuf), &pw) != 0 ||
173 pw == NULL || pw->pw_dir == NULL) {
174 major = GSS_S_CRED_UNAVAIL;
175 *minor = GSSEAP_GET_LAST_ERROR();
179 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", pw->pw_dir);
184 fp = fopen(ccacheName, "r");
186 major = GSS_S_CRED_UNAVAIL;
187 *minor = GSSEAP_NO_DEFAULT_CRED;
191 while (fgets(buf, sizeof(buf), fp) != NULL) {
192 gss_buffer_desc src, *dst;
194 src.length = strlen(buf);
200 if (buf[src.length - 1] == '\n') {
201 buf[src.length - 1] = '\0';
202 if (--src.length == 0)
207 dst = defaultIdentity;
209 dst = defaultPassword;
213 if (dst != GSS_C_NO_BUFFER) {
214 major = duplicateBuffer(minor, &src, dst);
215 if (GSS_ERROR(major))
222 if (defaultIdentity->length == 0) {
223 major = GSS_S_CRED_UNAVAIL;
224 *minor = GSSEAP_NO_DEFAULT_CRED;
228 major = GSS_S_COMPLETE;
235 if (GSS_ERROR(major)) {
236 gss_release_buffer(&tmpMinor, defaultIdentity);
237 zeroAndReleasePassword(defaultPassword);
240 memset(buf, 0, sizeof(buf));
246 gssEapPrimaryMechForCred(gss_cred_id_t cred)
248 gss_OID credMech = GSS_C_NO_OID;
250 if (cred != GSS_C_NO_CREDENTIAL &&
251 cred->mechanisms != GSS_C_NO_OID_SET &&
252 cred->mechanisms->count == 1)
253 credMech = &cred->mechanisms->elements[0];
259 gssEapAcquireCred(OM_uint32 *minor,
260 const gss_name_t desiredName,
261 OM_uint32 timeReq GSSEAP_UNUSED,
262 const gss_OID_set desiredMechs,
264 gss_cred_id_t *pCred,
265 gss_OID_set *pActualMechs,
268 OM_uint32 major, tmpMinor;
271 /* XXX TODO validate with changed set_cred_option API */
272 *pCred = GSS_C_NO_CREDENTIAL;
274 major = gssEapAllocCred(minor, &cred);
275 if (GSS_ERROR(major))
280 cred->flags |= CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT;
283 cred->flags |= CRED_FLAG_INITIATE;
286 cred->flags |= CRED_FLAG_ACCEPT;
289 major = GSS_S_FAILURE;
290 *minor = GSSEAP_BAD_USAGE;
295 major = gssEapValidateMechs(minor, desiredMechs);
296 if (GSS_ERROR(major))
299 major = duplicateOidSet(minor, desiredMechs, &cred->mechanisms);
300 if (GSS_ERROR(major))
303 if (desiredName != GSS_C_NO_NAME) {
304 GSSEAP_MUTEX_LOCK(&desiredName->mutex);
306 major = gssEapDuplicateName(minor, desiredName, &cred->name);
307 if (GSS_ERROR(major)) {
308 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
312 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
315 #ifdef GSSEAP_ENABLE_ACCEPTOR
316 if (cred->flags & CRED_FLAG_ACCEPT) {
317 struct rs_context *radContext;
319 major = gssEapCreateRadiusContext(minor, cred, &radContext);
320 if (GSS_ERROR(major))
323 rs_context_destroy(radContext);
327 if (pActualMechs != NULL) {
328 major = duplicateOidSet(minor, cred->mechanisms, pActualMechs);
329 if (GSS_ERROR(major))
334 *timeRec = GSS_C_INDEFINITE;
338 major = GSS_S_COMPLETE;
342 if (GSS_ERROR(major))
343 gssEapReleaseCred(&tmpMinor, &cred);
349 * Return TRUE if cred available for mechanism. Caller need no acquire
350 * lock because mechanisms list is immutable.
353 gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech)
358 GSSEAP_ASSERT(mech != GSS_C_NO_OID);
360 if (cred == GSS_C_NO_CREDENTIAL || cred->mechanisms == GSS_C_NO_OID_SET)
363 gss_test_oid_set_member(&minor, mech, cred->mechanisms, &present);
369 staticIdentityFileResolveDefaultIdentity(OM_uint32 *minor,
370 const gss_cred_id_t cred,
373 OM_uint32 major, tmpMinor;
374 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
375 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
377 *pName = GSS_C_NO_NAME;
379 major = readStaticIdentityFile(minor, &defaultIdentity, GSS_C_NO_BUFFER);
380 if (major == GSS_S_COMPLETE) {
381 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
385 gss_release_buffer(&tmpMinor, &defaultIdentity);
391 gssEapResolveCredIdentity(OM_uint32 *minor,
395 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
397 if (cred->name != GSS_C_NO_NAME) {
399 return GSS_S_COMPLETE;
402 if (cred->flags & CRED_FLAG_ACCEPT) {
403 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
404 char serviceName[5 + MAXHOSTNAMELEN];
406 /* default host-based service is host@localhost */
407 memcpy(serviceName, "host@", 5);
408 if (gethostname(&serviceName[5], MAXHOSTNAMELEN) != 0) {
409 *minor = GSSEAP_NO_HOSTNAME;
410 return GSS_S_FAILURE;
413 nameBuf.value = serviceName;
414 nameBuf.length = strlen((char *)nameBuf.value);
416 major = gssEapImportName(minor, &nameBuf, GSS_C_NT_HOSTBASED_SERVICE,
417 nameMech, &cred->name);
418 if (GSS_ERROR(major))
420 } else if (cred->flags & CRED_FLAG_INITIATE) {
421 #ifdef HAVE_MOONSHOT_GET_IDENTITY
422 major = libMoonshotResolveDefaultIdentity(minor, cred, &cred->name);
423 if (major == GSS_S_CRED_UNAVAIL)
425 major = staticIdentityFileResolveDefaultIdentity(minor, cred, &cred->name);
426 if (major != GSS_S_CRED_UNAVAIL)
431 return GSS_S_COMPLETE;
435 gssEapInquireCred(OM_uint32 *minor,
438 OM_uint32 *pLifetime,
439 gss_cred_usage_t *cred_usage,
440 gss_OID_set *mechanisms)
443 time_t now, lifetime;
446 major = gssEapResolveCredIdentity(minor, cred);
447 if (GSS_ERROR(major))
450 if (cred->name != GSS_C_NO_NAME) {
451 major = gssEapDuplicateName(minor, cred->name, name);
452 if (GSS_ERROR(major))
455 *name = GSS_C_NO_NAME;
458 if (cred_usage != NULL) {
459 OM_uint32 flags = (cred->flags & (CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT));
462 case CRED_FLAG_INITIATE:
463 *cred_usage = GSS_C_INITIATE;
465 case CRED_FLAG_ACCEPT:
466 *cred_usage = GSS_C_ACCEPT;
469 *cred_usage = GSS_C_BOTH;
474 if (mechanisms != NULL) {
475 if (cred->mechanisms != GSS_C_NO_OID_SET)
476 major = duplicateOidSet(minor, cred->mechanisms, mechanisms);
478 major = gssEapIndicateMechs(minor, mechanisms);
479 if (GSS_ERROR(major))
483 if (cred->expiryTime == 0) {
484 lifetime = GSS_C_INDEFINITE;
487 lifetime = now - cred->expiryTime;
492 if (pLifetime != NULL) {
493 *pLifetime = lifetime;
497 major = GSS_S_CREDENTIALS_EXPIRED;
498 *minor = GSSEAP_CRED_EXPIRED;
502 major = GSS_S_COMPLETE;
510 gssEapSetCredPassword(OM_uint32 *minor,
512 const gss_buffer_t password)
514 OM_uint32 major, tmpMinor;
515 gss_buffer_desc newPassword = GSS_C_EMPTY_BUFFER;
517 if (cred->flags & CRED_FLAG_RESOLVED) {
518 major = GSS_S_FAILURE;
519 *minor = GSSEAP_CRED_RESOLVED;
523 if (password != GSS_C_NO_BUFFER) {
524 major = duplicateBuffer(minor, password, &newPassword);
525 if (GSS_ERROR(major))
528 cred->flags |= CRED_FLAG_PASSWORD;
530 cred->flags &= ~(CRED_FLAG_PASSWORD);
533 gss_release_buffer(&tmpMinor, &cred->password);
534 cred->password = newPassword;
536 major = GSS_S_COMPLETE;
544 * Currently only the privateKey path is exposed to the application
545 * (via gss_set_cred_option() or the third line in ~/.gss_eap_id).
546 * At some point in the future we may add support for setting the
547 * client certificate separately.
550 gssEapSetCredClientCertificate(OM_uint32 *minor,
552 const gss_buffer_t clientCert,
553 const gss_buffer_t privateKey)
555 OM_uint32 major, tmpMinor;
556 gss_buffer_desc newClientCert = GSS_C_EMPTY_BUFFER;
557 gss_buffer_desc newPrivateKey = GSS_C_EMPTY_BUFFER;
559 if (cred->flags & CRED_FLAG_RESOLVED) {
560 major = GSS_S_FAILURE;
561 *minor = GSSEAP_CRED_RESOLVED;
565 if (clientCert == GSS_C_NO_BUFFER &&
566 privateKey == GSS_C_NO_BUFFER) {
567 cred->flags &= ~(CRED_FLAG_CERTIFICATE);
568 major = GSS_S_COMPLETE;
573 if (clientCert != GSS_C_NO_BUFFER) {
574 major = duplicateBuffer(minor, clientCert, &newClientCert);
575 if (GSS_ERROR(major))
579 if (privateKey != GSS_C_NO_BUFFER) {
580 major = duplicateBuffer(minor, privateKey, &newPrivateKey);
581 if (GSS_ERROR(major))
585 cred->flags |= CRED_FLAG_CERTIFICATE;
587 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
588 cred->clientCertificate = newClientCert;
590 gss_release_buffer(&tmpMinor, &cred->privateKey);
591 cred->privateKey = newPrivateKey;
593 major = GSS_S_COMPLETE;
597 if (GSS_ERROR(major)) {
598 gss_release_buffer(&tmpMinor, &newClientCert);
599 gss_release_buffer(&tmpMinor, &newPrivateKey);
606 gssEapSetCredService(OM_uint32 *minor,
608 const gss_name_t target)
610 OM_uint32 major, tmpMinor;
611 gss_name_t newTarget = GSS_C_NO_NAME;
613 if (cred->flags & CRED_FLAG_RESOLVED) {
614 major = GSS_S_FAILURE;
615 *minor = GSSEAP_CRED_RESOLVED;
619 if (target != GSS_C_NO_NAME) {
620 major = gssEapDuplicateName(minor, target, &newTarget);
621 if (GSS_ERROR(major))
624 cred->flags |= CRED_FLAG_TARGET;
626 cred->flags &= ~(CRED_FLAG_TARGET);
629 gssEapReleaseName(&tmpMinor, &cred->target);
630 cred->target = newTarget;
632 major = GSS_S_COMPLETE;
640 gssEapDuplicateCred(OM_uint32 *minor,
641 const gss_cred_id_t src,
644 OM_uint32 major, tmpMinor;
645 gss_cred_id_t dst = GSS_C_NO_CREDENTIAL;
647 *pDst = GSS_C_NO_CREDENTIAL;
649 major = gssEapAllocCred(minor, &dst);
650 if (GSS_ERROR(major))
653 dst->flags = src->flags;
655 if (src->name != GSS_C_NO_NAME) {
656 major = gssEapDuplicateName(minor, src->name, &dst->name);
657 if (GSS_ERROR(major))
661 if (src->target != GSS_C_NO_NAME) {
662 major = gssEapDuplicateName(minor, src->target, &dst->target);
663 if (GSS_ERROR(major))
667 if (src->password.value != NULL) {
668 major = duplicateBuffer(minor, &src->password, &dst->password);
669 if (GSS_ERROR(major))
673 major = duplicateOidSet(minor, src->mechanisms, &dst->mechanisms);
674 if (GSS_ERROR(major))
677 dst->expiryTime = src->expiryTime;
679 if (src->radiusConfigFile.value != NULL)
680 duplicateBufferOrCleanup(&src->radiusConfigFile, &dst->radiusConfigFile);
681 if (src->radiusConfigStanza.value != NULL)
682 duplicateBufferOrCleanup(&src->radiusConfigStanza, &dst->radiusConfigStanza);
683 if (src->caCertificate.value != NULL)
684 duplicateBufferOrCleanup(&src->caCertificate, &dst->caCertificate);
685 if (src->subjectNameConstraint.value != NULL)
686 duplicateBufferOrCleanup(&src->subjectNameConstraint, &dst->subjectNameConstraint);
687 if (src->subjectAltNameConstraint.value != NULL)
688 duplicateBufferOrCleanup(&src->subjectAltNameConstraint, &dst->subjectAltNameConstraint);
689 if (src->clientCertificate.value != NULL)
690 duplicateBufferOrCleanup(&src->clientCertificate, &dst->clientCertificate);
691 if (src->privateKey.value != NULL)
692 duplicateBufferOrCleanup(&src->privateKey, &dst->privateKey);
694 #ifdef GSSEAP_ENABLE_REAUTH
695 /* XXX krbCredCache, reauthCred */
699 dst = GSS_C_NO_CREDENTIAL;
701 major = GSS_S_COMPLETE;
705 gssEapReleaseCred(&tmpMinor, &dst);
711 staticIdentityFileResolveInitiatorCred(OM_uint32 *minor, gss_cred_id_t cred)
713 OM_uint32 major, tmpMinor;
714 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
715 gss_name_t defaultIdentityName = GSS_C_NO_NAME;
716 gss_buffer_desc defaultPassword = GSS_C_EMPTY_BUFFER;
717 int isDefaultIdentity = FALSE;
719 major = readStaticIdentityFile(minor, &defaultIdentity, &defaultPassword);
720 if (GSS_ERROR(major))
723 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
724 gssEapPrimaryMechForCred(cred), &defaultIdentityName);
725 if (GSS_ERROR(major))
728 if (defaultIdentityName == GSS_C_NO_NAME) {
729 if (cred->name == GSS_C_NO_NAME) {
730 major = GSS_S_CRED_UNAVAIL;
731 *minor = GSSEAP_NO_DEFAULT_IDENTITY;
735 if (cred->name == GSS_C_NO_NAME) {
736 cred->name = defaultIdentityName;
737 defaultIdentityName = GSS_C_NO_NAME;
738 isDefaultIdentity = TRUE;
740 major = gssEapCompareName(minor, cred->name,
741 defaultIdentityName, 0,
743 if (GSS_ERROR(major))
748 if (isDefaultIdentity &&
749 (cred->flags & CRED_FLAG_PASSWORD) == 0) {
750 major = gssEapSetCredPassword(minor, cred, &defaultPassword);
751 if (GSS_ERROR(major))
756 gssEapReleaseName(&tmpMinor, &defaultIdentityName);
757 zeroAndReleasePassword(&defaultPassword);
758 gss_release_buffer(&tmpMinor, &defaultIdentity);
764 gssEapResolveInitiatorCred(OM_uint32 *minor,
765 const gss_cred_id_t cred,
766 const gss_name_t targetName
767 #ifndef HAVE_MOONSHOT_GET_IDENTITY
771 gss_cred_id_t *pResolvedCred)
773 OM_uint32 major, tmpMinor;
774 gss_cred_id_t resolvedCred = GSS_C_NO_CREDENTIAL;
776 if (cred == GSS_C_NO_CREDENTIAL) {
777 major = gssEapAcquireCred(minor,
785 if (GSS_ERROR(major))
788 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
789 major = GSS_S_NO_CRED;
790 *minor = GSSEAP_CRED_USAGE_MISMATCH;
794 major = gssEapDuplicateCred(minor, cred, &resolvedCred);
795 if (GSS_ERROR(major))
799 if ((resolvedCred->flags & CRED_FLAG_RESOLVED) == 0) {
800 #ifdef HAVE_MOONSHOT_GET_IDENTITY
801 major = libMoonshotResolveInitiatorCred(minor, resolvedCred, targetName);
802 if (major == GSS_S_CRED_UNAVAIL)
804 major = staticIdentityFileResolveInitiatorCred(minor, resolvedCred);
805 if (GSS_ERROR(major) && major != GSS_S_CRED_UNAVAIL)
808 /* If we have a caller-supplied password, the credential is resolved. */
809 if ((resolvedCred->flags &
810 (CRED_FLAG_PASSWORD | CRED_FLAG_CERTIFICATE)) == 0) {
811 major = GSS_S_CRED_UNAVAIL;
812 *minor = GSSEAP_NO_DEFAULT_CRED;
816 resolvedCred->flags |= CRED_FLAG_RESOLVED;
819 *pResolvedCred = resolvedCred;
820 resolvedCred = GSS_C_NO_CREDENTIAL;
822 major = GSS_S_COMPLETE;
826 gssEapReleaseCred(&tmpMinor, &resolvedCred);