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);
107 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
108 gss_release_buffer(&tmpMinor, &cred->privateKey);
110 #ifdef GSSEAP_ENABLE_REAUTH
111 if (cred->krbCredCache != NULL) {
112 if (cred->flags & CRED_FLAG_DEFAULT_CCACHE)
113 krb5_cc_close(krbContext, cred->krbCredCache);
115 krb5_cc_destroy(krbContext, cred->krbCredCache);
117 if (cred->reauthCred != GSS_C_NO_CREDENTIAL)
118 gssReleaseCred(&tmpMinor, &cred->reauthCred);
121 GSSEAP_MUTEX_DESTROY(&cred->mutex);
122 memset(cred, 0, sizeof(*cred));
127 return GSS_S_COMPLETE;
131 readStaticIdentityFile(OM_uint32 *minor,
132 gss_buffer_t defaultIdentity,
133 gss_buffer_t defaultPassword)
135 OM_uint32 major, tmpMinor;
141 struct passwd *pw = NULL, pwd;
145 defaultIdentity->length = 0;
146 defaultIdentity->value = NULL;
148 if (defaultPassword != GSS_C_NO_BUFFER) {
149 defaultPassword->length = 0;
150 defaultPassword->value = NULL;
153 ccacheName = getenv("GSSEAP_IDENTITY");
154 if (ccacheName == NULL) {
156 TCHAR szPath[MAX_PATH];
158 if (!SUCCEEDED(SHGetFolderPath(NULL,
159 CSIDL_APPDATA, /* |CSIDL_FLAG_CREATE */
160 NULL, /* User access token */
161 0, /* SHGFP_TYPE_CURRENT */
163 major = GSS_S_CRED_UNAVAIL;
164 *minor = GSSEAP_GET_LAST_ERROR(); /* XXX */
168 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", szPath);
170 if (getpwuid_r(getuid(), &pwd, pwbuf, sizeof(pwbuf), &pw) != 0 ||
171 pw == NULL || pw->pw_dir == NULL) {
172 major = GSS_S_CRED_UNAVAIL;
173 *minor = GSSEAP_GET_LAST_ERROR();
177 snprintf(buf, sizeof(buf), "%s/.gss_eap_id", pw->pw_dir);
182 fp = fopen(ccacheName, "r");
184 major = GSS_S_CRED_UNAVAIL;
185 *minor = GSSEAP_NO_DEFAULT_CRED;
189 while (fgets(buf, sizeof(buf), fp) != NULL) {
190 gss_buffer_desc src, *dst;
192 src.length = strlen(buf);
198 if (buf[src.length - 1] == '\n') {
199 buf[src.length - 1] = '\0';
200 if (--src.length == 0)
205 dst = defaultIdentity;
207 dst = defaultPassword;
211 if (dst != GSS_C_NO_BUFFER) {
212 major = duplicateBuffer(minor, &src, dst);
213 if (GSS_ERROR(major))
220 if (defaultIdentity->length == 0) {
221 major = GSS_S_CRED_UNAVAIL;
222 *minor = GSSEAP_NO_DEFAULT_CRED;
226 major = GSS_S_COMPLETE;
233 if (GSS_ERROR(major)) {
234 gss_release_buffer(&tmpMinor, defaultIdentity);
235 zeroAndReleasePassword(defaultPassword);
238 memset(buf, 0, sizeof(buf));
244 gssEapPrimaryMechForCred(gss_cred_id_t cred)
246 gss_OID credMech = GSS_C_NO_OID;
248 if (cred != GSS_C_NO_CREDENTIAL &&
249 cred->mechanisms != GSS_C_NO_OID_SET &&
250 cred->mechanisms->count == 1)
251 credMech = &cred->mechanisms->elements[0];
257 gssEapAcquireCred(OM_uint32 *minor,
258 const gss_name_t desiredName,
259 OM_uint32 timeReq GSSEAP_UNUSED,
260 const gss_OID_set desiredMechs,
262 gss_cred_id_t *pCred,
263 gss_OID_set *pActualMechs,
266 OM_uint32 major, tmpMinor;
269 /* XXX TODO validate with changed set_cred_option API */
270 *pCred = GSS_C_NO_CREDENTIAL;
272 major = gssEapAllocCred(minor, &cred);
273 if (GSS_ERROR(major))
278 cred->flags |= CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT;
281 cred->flags |= CRED_FLAG_INITIATE;
284 cred->flags |= CRED_FLAG_ACCEPT;
287 major = GSS_S_FAILURE;
288 *minor = GSSEAP_BAD_USAGE;
293 major = gssEapValidateMechs(minor, desiredMechs);
294 if (GSS_ERROR(major))
297 major = duplicateOidSet(minor, desiredMechs, &cred->mechanisms);
298 if (GSS_ERROR(major))
301 if (desiredName != GSS_C_NO_NAME) {
302 GSSEAP_MUTEX_LOCK(&desiredName->mutex);
304 major = gssEapDuplicateName(minor, desiredName, &cred->name);
305 if (GSS_ERROR(major)) {
306 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
310 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
313 #ifdef GSSEAP_ENABLE_ACCEPTOR
314 if (cred->flags & CRED_FLAG_ACCEPT) {
315 struct rs_context *radContext;
317 major = gssEapCreateRadiusContext(minor, cred, &radContext);
318 if (GSS_ERROR(major))
321 rs_context_destroy(radContext);
325 if (pActualMechs != NULL) {
326 major = duplicateOidSet(minor, cred->mechanisms, pActualMechs);
327 if (GSS_ERROR(major))
332 *timeRec = GSS_C_INDEFINITE;
336 major = GSS_S_COMPLETE;
340 if (GSS_ERROR(major))
341 gssEapReleaseCred(&tmpMinor, &cred);
347 * Return TRUE if cred available for mechanism. Caller need no acquire
348 * lock because mechanisms list is immutable.
351 gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech)
356 GSSEAP_ASSERT(mech != GSS_C_NO_OID);
358 if (cred == GSS_C_NO_CREDENTIAL || cred->mechanisms == GSS_C_NO_OID_SET)
361 gss_test_oid_set_member(&minor, mech, cred->mechanisms, &present);
367 staticIdentityFileResolveDefaultIdentity(OM_uint32 *minor,
368 const gss_cred_id_t cred,
371 OM_uint32 major, tmpMinor;
372 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
373 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
375 *pName = GSS_C_NO_NAME;
377 major = readStaticIdentityFile(minor, &defaultIdentity, GSS_C_NO_BUFFER);
378 if (major == GSS_S_COMPLETE) {
379 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
383 gss_release_buffer(&tmpMinor, &defaultIdentity);
389 gssEapResolveCredIdentity(OM_uint32 *minor,
393 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
395 if (cred->name != GSS_C_NO_NAME) {
397 return GSS_S_COMPLETE;
400 if (cred->flags & CRED_FLAG_ACCEPT) {
401 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
402 char serviceName[5 + MAXHOSTNAMELEN];
404 /* default host-based service is host@localhost */
405 memcpy(serviceName, "host@", 5);
406 if (gethostname(&serviceName[5], MAXHOSTNAMELEN) != 0) {
407 *minor = GSSEAP_NO_HOSTNAME;
408 return GSS_S_FAILURE;
411 nameBuf.value = serviceName;
412 nameBuf.length = strlen((char *)nameBuf.value);
414 major = gssEapImportName(minor, &nameBuf, GSS_C_NT_HOSTBASED_SERVICE,
415 nameMech, &cred->name);
416 if (GSS_ERROR(major))
418 } else if (cred->flags & CRED_FLAG_INITIATE) {
419 #ifdef HAVE_MOONSHOT_GET_IDENTITY
420 major = libMoonshotResolveDefaultIdentity(minor, cred, &cred->name);
421 if (major == GSS_S_CRED_UNAVAIL)
423 major = staticIdentityFileResolveDefaultIdentity(minor, cred, &cred->name);
424 if (major != GSS_S_CRED_UNAVAIL)
429 return GSS_S_COMPLETE;
433 gssEapInquireCred(OM_uint32 *minor,
436 OM_uint32 *pLifetime,
437 gss_cred_usage_t *cred_usage,
438 gss_OID_set *mechanisms)
441 time_t now, lifetime;
444 major = gssEapResolveCredIdentity(minor, cred);
445 if (GSS_ERROR(major))
448 if (cred->name != GSS_C_NO_NAME) {
449 major = gssEapDuplicateName(minor, cred->name, name);
450 if (GSS_ERROR(major))
453 *name = GSS_C_NO_NAME;
456 if (cred_usage != NULL) {
457 OM_uint32 flags = (cred->flags & (CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT));
460 case CRED_FLAG_INITIATE:
461 *cred_usage = GSS_C_INITIATE;
463 case CRED_FLAG_ACCEPT:
464 *cred_usage = GSS_C_ACCEPT;
467 *cred_usage = GSS_C_BOTH;
472 if (mechanisms != NULL) {
473 if (cred->mechanisms != GSS_C_NO_OID_SET)
474 major = duplicateOidSet(minor, cred->mechanisms, mechanisms);
476 major = gssEapIndicateMechs(minor, mechanisms);
477 if (GSS_ERROR(major))
481 if (cred->expiryTime == 0) {
482 lifetime = GSS_C_INDEFINITE;
485 lifetime = now - cred->expiryTime;
490 if (pLifetime != NULL) {
491 *pLifetime = lifetime;
495 major = GSS_S_CREDENTIALS_EXPIRED;
496 *minor = GSSEAP_CRED_EXPIRED;
500 major = GSS_S_COMPLETE;
508 gssEapSetCredPassword(OM_uint32 *minor,
510 const gss_buffer_t password)
512 OM_uint32 major, tmpMinor;
513 gss_buffer_desc newPassword = GSS_C_EMPTY_BUFFER;
515 if (cred->flags & CRED_FLAG_RESOLVED) {
516 major = GSS_S_FAILURE;
517 *minor = GSSEAP_CRED_RESOLVED;
521 if (password != GSS_C_NO_BUFFER) {
522 major = duplicateBuffer(minor, password, &newPassword);
523 if (GSS_ERROR(major))
526 cred->flags |= CRED_FLAG_PASSWORD;
528 cred->flags &= ~(CRED_FLAG_PASSWORD);
531 gss_release_buffer(&tmpMinor, &cred->password);
532 cred->password = newPassword;
534 major = GSS_S_COMPLETE;
542 * Currently only the privateKey path is exposed to the application
543 * (via gss_set_cred_option() or the third line in ~/.gss_eap_id).
544 * At some point in the future we may add support for setting the
545 * client certificate separately.
548 gssEapSetCredClientCertificate(OM_uint32 *minor,
550 const gss_buffer_t clientCert,
551 const gss_buffer_t privateKey)
553 OM_uint32 major, tmpMinor;
554 gss_buffer_desc newClientCert = GSS_C_EMPTY_BUFFER;
555 gss_buffer_desc newPrivateKey = GSS_C_EMPTY_BUFFER;
557 if (cred->flags & CRED_FLAG_RESOLVED) {
558 major = GSS_S_FAILURE;
559 *minor = GSSEAP_CRED_RESOLVED;
563 if (clientCert == GSS_C_NO_BUFFER &&
564 privateKey == GSS_C_NO_BUFFER) {
565 cred->flags &= ~(CRED_FLAG_CERTIFICATE);
566 major = GSS_S_COMPLETE;
571 if (clientCert != GSS_C_NO_BUFFER) {
572 major = duplicateBuffer(minor, clientCert, &newClientCert);
573 if (GSS_ERROR(major))
577 if (privateKey != GSS_C_NO_BUFFER) {
578 major = duplicateBuffer(minor, privateKey, &newPrivateKey);
579 if (GSS_ERROR(major))
583 cred->flags |= CRED_FLAG_CERTIFICATE;
585 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
586 cred->clientCertificate = newClientCert;
588 gss_release_buffer(&tmpMinor, &cred->privateKey);
589 cred->privateKey = newPrivateKey;
591 major = GSS_S_COMPLETE;
595 if (GSS_ERROR(major)) {
596 gss_release_buffer(&tmpMinor, &newClientCert);
597 gss_release_buffer(&tmpMinor, &newPrivateKey);
604 gssEapSetCredService(OM_uint32 *minor,
606 const gss_name_t target)
608 OM_uint32 major, tmpMinor;
609 gss_name_t newTarget = GSS_C_NO_NAME;
611 if (cred->flags & CRED_FLAG_RESOLVED) {
612 major = GSS_S_FAILURE;
613 *minor = GSSEAP_CRED_RESOLVED;
617 if (target != GSS_C_NO_NAME) {
618 major = gssEapDuplicateName(minor, target, &newTarget);
619 if (GSS_ERROR(major))
622 cred->flags |= CRED_FLAG_TARGET;
624 cred->flags &= ~(CRED_FLAG_TARGET);
627 gssEapReleaseName(&tmpMinor, &cred->target);
628 cred->target = newTarget;
630 major = GSS_S_COMPLETE;
638 gssEapDuplicateCred(OM_uint32 *minor,
639 const gss_cred_id_t src,
642 OM_uint32 major, tmpMinor;
643 gss_cred_id_t dst = GSS_C_NO_CREDENTIAL;
645 *pDst = GSS_C_NO_CREDENTIAL;
647 major = gssEapAllocCred(minor, &dst);
648 if (GSS_ERROR(major))
651 dst->flags = src->flags;
653 if (src->name != GSS_C_NO_NAME) {
654 major = gssEapDuplicateName(minor, src->name, &dst->name);
655 if (GSS_ERROR(major))
659 if (src->target != GSS_C_NO_NAME) {
660 major = gssEapDuplicateName(minor, src->target, &dst->target);
661 if (GSS_ERROR(major))
665 if (src->password.value != NULL) {
666 major = duplicateBuffer(minor, &src->password, &dst->password);
667 if (GSS_ERROR(major))
671 major = duplicateOidSet(minor, src->mechanisms, &dst->mechanisms);
672 if (GSS_ERROR(major))
675 dst->expiryTime = src->expiryTime;
677 if (src->radiusConfigFile.value != NULL)
678 duplicateBufferOrCleanup(&src->radiusConfigFile, &dst->radiusConfigFile);
679 if (src->radiusConfigStanza.value != NULL)
680 duplicateBufferOrCleanup(&src->radiusConfigStanza, &dst->radiusConfigStanza);
681 if (src->caCertificate.value != NULL)
682 duplicateBufferOrCleanup(&src->caCertificate, &dst->caCertificate);
683 if (src->subjectNameConstraint.value != NULL)
684 duplicateBufferOrCleanup(&src->subjectNameConstraint, &dst->subjectNameConstraint);
685 if (src->subjectAltNameConstraint.value != NULL)
686 duplicateBufferOrCleanup(&src->subjectAltNameConstraint, &dst->subjectAltNameConstraint);
687 if (src->clientCertificate.value != NULL)
688 duplicateBufferOrCleanup(&src->clientCertificate, &dst->clientCertificate);
689 if (src->privateKey.value != NULL)
690 duplicateBufferOrCleanup(&src->privateKey, &dst->privateKey);
692 #ifdef GSSEAP_ENABLE_REAUTH
693 /* XXX krbCredCache, reauthCred */
697 dst = GSS_C_NO_CREDENTIAL;
699 major = GSS_S_COMPLETE;
703 gssEapReleaseCred(&tmpMinor, &dst);
709 staticIdentityFileResolveInitiatorCred(OM_uint32 *minor, gss_cred_id_t cred)
711 OM_uint32 major, tmpMinor;
712 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
713 gss_name_t defaultIdentityName = GSS_C_NO_NAME;
714 gss_buffer_desc defaultPassword = GSS_C_EMPTY_BUFFER;
715 int isDefaultIdentity = FALSE;
717 major = readStaticIdentityFile(minor, &defaultIdentity, &defaultPassword);
718 if (GSS_ERROR(major))
721 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
722 gssEapPrimaryMechForCred(cred), &defaultIdentityName);
723 if (GSS_ERROR(major))
726 if (defaultIdentityName == GSS_C_NO_NAME) {
727 if (cred->name == GSS_C_NO_NAME) {
728 major = GSS_S_CRED_UNAVAIL;
729 *minor = GSSEAP_NO_DEFAULT_IDENTITY;
733 if (cred->name == GSS_C_NO_NAME) {
734 cred->name = defaultIdentityName;
735 defaultIdentityName = GSS_C_NO_NAME;
736 isDefaultIdentity = TRUE;
738 major = gssEapCompareName(minor, cred->name,
739 defaultIdentityName, 0,
741 if (GSS_ERROR(major))
746 if (isDefaultIdentity &&
747 (cred->flags & CRED_FLAG_PASSWORD) == 0) {
748 major = gssEapSetCredPassword(minor, cred, &defaultPassword);
749 if (GSS_ERROR(major))
754 gssEapReleaseName(&tmpMinor, &defaultIdentityName);
755 zeroAndReleasePassword(&defaultPassword);
756 gss_release_buffer(&tmpMinor, &defaultIdentity);
762 gssEapResolveInitiatorCred(OM_uint32 *minor,
763 const gss_cred_id_t cred,
764 const gss_name_t targetName
765 #ifndef HAVE_MOONSHOT_GET_IDENTITY
769 gss_cred_id_t *pResolvedCred)
771 OM_uint32 major, tmpMinor;
772 gss_cred_id_t resolvedCred = GSS_C_NO_CREDENTIAL;
774 if (cred == GSS_C_NO_CREDENTIAL) {
775 major = gssEapAcquireCred(minor,
783 if (GSS_ERROR(major))
786 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
787 major = GSS_S_NO_CRED;
788 *minor = GSSEAP_CRED_USAGE_MISMATCH;
792 major = gssEapDuplicateCred(minor, cred, &resolvedCred);
793 if (GSS_ERROR(major))
797 if ((resolvedCred->flags & CRED_FLAG_RESOLVED) == 0) {
798 #ifdef HAVE_MOONSHOT_GET_IDENTITY
799 major = libMoonshotResolveInitiatorCred(minor, resolvedCred, targetName);
800 if (major == GSS_S_CRED_UNAVAIL)
802 major = staticIdentityFileResolveInitiatorCred(minor, resolvedCred);
803 if (GSS_ERROR(major) && major != GSS_S_CRED_UNAVAIL)
806 /* If we have a caller-supplied password, the credential is resolved. */
807 if ((resolvedCred->flags &
808 (CRED_FLAG_PASSWORD | CRED_FLAG_CERTIFICATE)) == 0) {
809 major = GSS_S_CRED_UNAVAIL;
810 *minor = GSSEAP_NO_DEFAULT_CRED;
814 resolvedCred->flags |= CRED_FLAG_RESOLVED;
817 *pResolvedCred = resolvedCred;
818 resolvedCred = GSS_C_NO_CREDENTIAL;
820 major = GSS_S_COMPLETE;
824 gssEapReleaseCred(&tmpMinor, &resolvedCred);