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 nameMech = GSS_C_NO_OID;
248 if (cred->mechanisms != GSS_C_NO_OID_SET &&
249 cred->mechanisms->count == 1)
250 nameMech = &cred->mechanisms->elements[0];
256 gssEapAcquireCred(OM_uint32 *minor,
257 const gss_name_t desiredName,
258 OM_uint32 timeReq GSSEAP_UNUSED,
259 const gss_OID_set desiredMechs,
261 gss_cred_id_t *pCred,
262 gss_OID_set *pActualMechs,
265 OM_uint32 major, tmpMinor;
268 /* XXX TODO validate with changed set_cred_option API */
269 *pCred = GSS_C_NO_CREDENTIAL;
271 major = gssEapAllocCred(minor, &cred);
272 if (GSS_ERROR(major))
277 cred->flags |= CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT;
280 cred->flags |= CRED_FLAG_INITIATE;
283 cred->flags |= CRED_FLAG_ACCEPT;
286 major = GSS_S_FAILURE;
287 *minor = GSSEAP_BAD_USAGE;
292 major = gssEapValidateMechs(minor, desiredMechs);
293 if (GSS_ERROR(major))
296 major = duplicateOidSet(minor, desiredMechs, &cred->mechanisms);
297 if (GSS_ERROR(major))
300 if (desiredName != GSS_C_NO_NAME) {
301 GSSEAP_MUTEX_LOCK(&desiredName->mutex);
303 major = gssEapDuplicateName(minor, desiredName, &cred->name);
304 if (GSS_ERROR(major)) {
305 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
309 GSSEAP_MUTEX_UNLOCK(&desiredName->mutex);
312 #ifdef GSSEAP_ENABLE_ACCEPTOR
313 if (cred->flags & CRED_FLAG_ACCEPT) {
314 struct rs_context *radContext;
316 major = gssEapCreateRadiusContext(minor, cred, &radContext);
317 if (GSS_ERROR(major))
320 rs_context_destroy(radContext);
324 if (pActualMechs != NULL) {
325 major = duplicateOidSet(minor, cred->mechanisms, pActualMechs);
326 if (GSS_ERROR(major))
331 *timeRec = GSS_C_INDEFINITE;
335 major = GSS_S_COMPLETE;
339 if (GSS_ERROR(major))
340 gssEapReleaseCred(&tmpMinor, &cred);
346 * Return TRUE if cred available for mechanism. Caller need no acquire
347 * lock because mechanisms list is immutable.
350 gssEapCredAvailable(gss_cred_id_t cred, gss_OID mech)
355 GSSEAP_ASSERT(mech != GSS_C_NO_OID);
357 if (cred == GSS_C_NO_CREDENTIAL || cred->mechanisms == GSS_C_NO_OID_SET)
360 gss_test_oid_set_member(&minor, mech, cred->mechanisms, &present);
366 staticIdentityFileResolveDefaultIdentity(OM_uint32 *minor,
367 const gss_cred_id_t cred,
370 OM_uint32 major, tmpMinor;
371 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
372 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
374 *pName = GSS_C_NO_NAME;
376 major = readStaticIdentityFile(minor, &defaultIdentity, GSS_C_NO_BUFFER);
377 if (major == GSS_S_COMPLETE) {
378 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
382 gss_release_buffer(&tmpMinor, &defaultIdentity);
388 gssEapResolveCredIdentity(OM_uint32 *minor,
392 gss_OID nameMech = gssEapPrimaryMechForCred(cred);
394 if (cred->name != GSS_C_NO_NAME) {
396 return GSS_S_COMPLETE;
399 if (cred->flags & CRED_FLAG_ACCEPT) {
400 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
401 char serviceName[5 + MAXHOSTNAMELEN];
403 /* default host-based service is host@localhost */
404 memcpy(serviceName, "host@", 5);
405 if (gethostname(&serviceName[5], MAXHOSTNAMELEN) != 0) {
406 *minor = GSSEAP_NO_HOSTNAME;
407 return GSS_S_FAILURE;
410 nameBuf.value = serviceName;
411 nameBuf.length = strlen((char *)nameBuf.value);
413 major = gssEapImportName(minor, &nameBuf, GSS_C_NT_HOSTBASED_SERVICE,
414 nameMech, &cred->name);
415 if (GSS_ERROR(major))
417 } else if (cred->flags & CRED_FLAG_INITIATE) {
418 #ifdef HAVE_MOONSHOT_GET_IDENTITY
419 major = libMoonshotResolveDefaultIdentity(minor, cred, &cred->name);
420 if (major == GSS_S_CRED_UNAVAIL)
422 major = staticIdentityFileResolveDefaultIdentity(minor, cred, &cred->name);
423 if (major != GSS_S_CRED_UNAVAIL)
428 return GSS_S_COMPLETE;
432 gssEapInquireCred(OM_uint32 *minor,
435 OM_uint32 *pLifetime,
436 gss_cred_usage_t *cred_usage,
437 gss_OID_set *mechanisms)
440 time_t now, lifetime;
443 major = gssEapResolveCredIdentity(minor, cred);
444 if (GSS_ERROR(major))
447 if (cred->name != GSS_C_NO_NAME) {
448 major = gssEapDuplicateName(minor, cred->name, name);
449 if (GSS_ERROR(major))
452 *name = GSS_C_NO_NAME;
455 if (cred_usage != NULL) {
456 OM_uint32 flags = (cred->flags & (CRED_FLAG_INITIATE | CRED_FLAG_ACCEPT));
459 case CRED_FLAG_INITIATE:
460 *cred_usage = GSS_C_INITIATE;
462 case CRED_FLAG_ACCEPT:
463 *cred_usage = GSS_C_ACCEPT;
466 *cred_usage = GSS_C_BOTH;
471 if (mechanisms != NULL) {
472 if (cred->mechanisms != GSS_C_NO_OID_SET)
473 major = duplicateOidSet(minor, cred->mechanisms, mechanisms);
475 major = gssEapIndicateMechs(minor, mechanisms);
476 if (GSS_ERROR(major))
480 if (cred->expiryTime == 0) {
481 lifetime = GSS_C_INDEFINITE;
484 lifetime = now - cred->expiryTime;
489 if (pLifetime != NULL) {
490 *pLifetime = lifetime;
494 major = GSS_S_CREDENTIALS_EXPIRED;
495 *minor = GSSEAP_CRED_EXPIRED;
499 major = GSS_S_COMPLETE;
507 gssEapSetCredPassword(OM_uint32 *minor,
509 const gss_buffer_t password)
511 OM_uint32 major, tmpMinor;
512 gss_buffer_desc newPassword = GSS_C_EMPTY_BUFFER;
514 if (cred->flags & CRED_FLAG_RESOLVED) {
515 major = GSS_S_FAILURE;
516 *minor = GSSEAP_CRED_RESOLVED;
520 if (password != GSS_C_NO_BUFFER) {
521 major = duplicateBuffer(minor, password, &newPassword);
522 if (GSS_ERROR(major))
525 cred->flags |= CRED_FLAG_PASSWORD;
527 cred->flags &= ~(CRED_FLAG_PASSWORD);
530 gss_release_buffer(&tmpMinor, &cred->password);
531 cred->password = newPassword;
533 major = GSS_S_COMPLETE;
541 * Currently only the privateKey path is exposed to the application
542 * (via gss_set_cred_option() or the third line in ~/.gss_eap_id).
543 * At some point in the future we may add support for setting the
544 * client certificate separately.
547 gssEapSetCredClientCertificate(OM_uint32 *minor,
549 const gss_buffer_t clientCert,
550 const gss_buffer_t privateKey)
552 OM_uint32 major, tmpMinor;
553 gss_buffer_desc newClientCert = GSS_C_EMPTY_BUFFER;
554 gss_buffer_desc newPrivateKey = GSS_C_EMPTY_BUFFER;
556 if (cred->flags & CRED_FLAG_RESOLVED) {
557 major = GSS_S_FAILURE;
558 *minor = GSSEAP_CRED_RESOLVED;
562 if (clientCert == GSS_C_NO_BUFFER &&
563 privateKey == GSS_C_NO_BUFFER) {
564 cred->flags &= ~(CRED_FLAG_CERTIFICATE);
565 major = GSS_S_COMPLETE;
570 if (clientCert != GSS_C_NO_BUFFER) {
571 major = duplicateBuffer(minor, clientCert, &newClientCert);
572 if (GSS_ERROR(major))
576 if (privateKey != GSS_C_NO_BUFFER) {
577 major = duplicateBuffer(minor, privateKey, &newPrivateKey);
578 if (GSS_ERROR(major))
582 cred->flags |= CRED_FLAG_CERTIFICATE;
584 gss_release_buffer(&tmpMinor, &cred->clientCertificate);
585 cred->clientCertificate = newClientCert;
587 gss_release_buffer(&tmpMinor, &cred->privateKey);
588 cred->privateKey = newPrivateKey;
590 major = GSS_S_COMPLETE;
594 if (GSS_ERROR(major)) {
595 gss_release_buffer(&tmpMinor, &newClientCert);
596 gss_release_buffer(&tmpMinor, &newPrivateKey);
603 gssEapSetCredService(OM_uint32 *minor,
605 const gss_name_t target)
607 OM_uint32 major, tmpMinor;
608 gss_name_t newTarget = GSS_C_NO_NAME;
610 if (cred->flags & CRED_FLAG_RESOLVED) {
611 major = GSS_S_FAILURE;
612 *minor = GSSEAP_CRED_RESOLVED;
616 if (target != GSS_C_NO_NAME) {
617 major = gssEapDuplicateName(minor, target, &newTarget);
618 if (GSS_ERROR(major))
621 cred->flags |= CRED_FLAG_TARGET;
623 cred->flags &= ~(CRED_FLAG_TARGET);
626 gssEapReleaseName(&tmpMinor, &cred->target);
627 cred->target = newTarget;
629 major = GSS_S_COMPLETE;
637 gssEapDuplicateCred(OM_uint32 *minor,
638 const gss_cred_id_t src,
641 OM_uint32 major, tmpMinor;
642 gss_cred_id_t dst = GSS_C_NO_CREDENTIAL;
644 *pDst = GSS_C_NO_CREDENTIAL;
646 major = gssEapAllocCred(minor, &dst);
647 if (GSS_ERROR(major))
650 dst->flags = src->flags;
652 if (src->name != GSS_C_NO_NAME) {
653 major = gssEapDuplicateName(minor, src->name, &dst->name);
654 if (GSS_ERROR(major))
658 if (src->target != GSS_C_NO_NAME) {
659 major = gssEapDuplicateName(minor, src->target, &dst->target);
660 if (GSS_ERROR(major))
664 if (src->password.value != NULL) {
665 major = duplicateBuffer(minor, &src->password, &dst->password);
666 if (GSS_ERROR(major))
670 major = duplicateOidSet(minor, src->mechanisms, &dst->mechanisms);
671 if (GSS_ERROR(major))
674 dst->expiryTime = src->expiryTime;
676 if (src->radiusConfigFile.value != NULL)
677 duplicateBufferOrCleanup(&src->radiusConfigFile, &dst->radiusConfigFile);
678 if (src->radiusConfigStanza.value != NULL)
679 duplicateBufferOrCleanup(&src->radiusConfigStanza, &dst->radiusConfigStanza);
680 if (src->caCertificate.value != NULL)
681 duplicateBufferOrCleanup(&src->caCertificate, &dst->caCertificate);
682 if (src->subjectNameConstraint.value != NULL)
683 duplicateBufferOrCleanup(&src->subjectNameConstraint, &dst->subjectNameConstraint);
684 if (src->subjectAltNameConstraint.value != NULL)
685 duplicateBufferOrCleanup(&src->subjectAltNameConstraint, &dst->subjectAltNameConstraint);
686 if (src->clientCertificate.value != NULL)
687 duplicateBufferOrCleanup(&src->clientCertificate, &dst->clientCertificate);
688 if (src->privateKey.value != NULL)
689 duplicateBufferOrCleanup(&src->privateKey, &dst->privateKey);
691 #ifdef GSSEAP_ENABLE_REAUTH
692 /* XXX krbCredCache, reauthCred */
696 dst = GSS_C_NO_CREDENTIAL;
698 major = GSS_S_COMPLETE;
702 gssEapReleaseCred(&tmpMinor, &dst);
708 staticIdentityFileResolveInitiatorCred(OM_uint32 *minor, gss_cred_id_t cred)
710 OM_uint32 major, tmpMinor;
711 gss_buffer_desc defaultIdentity = GSS_C_EMPTY_BUFFER;
712 gss_name_t defaultIdentityName = GSS_C_NO_NAME;
713 gss_buffer_desc defaultPassword = GSS_C_EMPTY_BUFFER;
714 int isDefaultIdentity = FALSE;
716 major = readStaticIdentityFile(minor, &defaultIdentity, &defaultPassword);
717 if (GSS_ERROR(major))
720 major = gssEapImportName(minor, &defaultIdentity, GSS_C_NT_USER_NAME,
721 gssEapPrimaryMechForCred(cred), &defaultIdentityName);
722 if (GSS_ERROR(major))
725 if (defaultIdentityName == GSS_C_NO_NAME) {
726 if (cred->name == GSS_C_NO_NAME) {
727 major = GSS_S_CRED_UNAVAIL;
728 *minor = GSSEAP_NO_DEFAULT_IDENTITY;
732 if (cred->name == GSS_C_NO_NAME) {
733 cred->name = defaultIdentityName;
734 defaultIdentityName = GSS_C_NO_NAME;
735 isDefaultIdentity = TRUE;
737 major = gssEapCompareName(minor, cred->name,
738 defaultIdentityName, &isDefaultIdentity);
739 if (GSS_ERROR(major))
744 if (isDefaultIdentity &&
745 (cred->flags & CRED_FLAG_PASSWORD) == 0) {
746 major = gssEapSetCredPassword(minor, cred, &defaultPassword);
747 if (GSS_ERROR(major))
752 gssEapReleaseName(&tmpMinor, &defaultIdentityName);
753 zeroAndReleasePassword(&defaultPassword);
754 gss_release_buffer(&tmpMinor, &defaultIdentity);
760 gssEapResolveInitiatorCred(OM_uint32 *minor,
761 const gss_cred_id_t cred,
762 const gss_name_t targetName
763 #ifndef HAVE_MOONSHOT_GET_IDENTITY
767 gss_cred_id_t *pResolvedCred)
769 OM_uint32 major, tmpMinor;
770 gss_cred_id_t resolvedCred = GSS_C_NO_CREDENTIAL;
772 if (cred == GSS_C_NO_CREDENTIAL) {
773 major = gssEapAcquireCred(minor,
781 if (GSS_ERROR(major))
784 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
785 major = GSS_S_NO_CRED;
786 *minor = GSSEAP_CRED_USAGE_MISMATCH;
790 major = gssEapDuplicateCred(minor, cred, &resolvedCred);
791 if (GSS_ERROR(major))
795 if ((resolvedCred->flags & CRED_FLAG_RESOLVED) == 0) {
796 #ifdef HAVE_MOONSHOT_GET_IDENTITY
797 major = libMoonshotResolveInitiatorCred(minor, resolvedCred, targetName);
798 if (major == GSS_S_CRED_UNAVAIL)
800 major = staticIdentityFileResolveInitiatorCred(minor, resolvedCred);
801 if (GSS_ERROR(major) && major != GSS_S_CRED_UNAVAIL)
804 /* If we have a caller-supplied password, the credential is resolved. */
805 if ((resolvedCred->flags &
806 (CRED_FLAG_PASSWORD | CRED_FLAG_CERTIFICATE)) == 0) {
807 major = GSS_S_CRED_UNAVAIL;
808 *minor = GSSEAP_NO_DEFAULT_CRED;
812 resolvedCred->flags |= CRED_FLAG_RESOLVED;
815 *pResolvedCred = resolvedCred;
816 resolvedCred = GSS_C_NO_CREDENTIAL;
818 major = GSS_S_COMPLETE;
822 gssEapReleaseCred(&tmpMinor, &resolvedCred);