4 * Authentication functions for the Common UNIX Printing System (CUPS).
6 * Copyright 2007-2009 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products.
9 * This file contains Kerberos support code, copyright 2006 by
12 * These coded instructions, statements, and computer programs are the
13 * property of Apple Inc. and are protected by Federal copyright
14 * law. Distribution and use rights are outlined in the file "LICENSE.txt"
15 * which should have been included with this file. If this file is
16 * file is missing or damaged, see the license at "http://www.cups.org/".
18 * This file is subject to the Apple OS-Developed Software exception.
22 * cupsDoAuthentication() - Authenticate a request.
23 * cups_get_gssname() - Get GSSAPI name for authentication.
24 * cups_gss_printf() - Show error messages from GSSAPI...
25 * cups_local_auth() - Get the local authorization certificate if
26 * available/applicable...
30 * Include necessary headers...
40 #if defined(WIN32) || defined(__EMX__)
44 #endif /* WIN32 || __EMX__ */
46 #if HAVE_AUTHORIZATION_H
47 # include <Security/Authorization.h>
48 # ifdef HAVE_SECBASEPRIV_H
49 # include <Security/SecBasePriv.h>
51 extern const char *cssmErrorString(int error
);
52 # endif /* HAVE_SECBASEPRIV_H */
53 #endif /* HAVE_AUTHORIZATION_H */
55 #if defined(SO_PEERCRED) && defined(AF_LOCAL)
57 #endif /* SO_PEERCRED && AF_LOCAL */
65 static gss_name_t
cups_get_gssname(http_t
*http
, const char *service_name
);
67 static void cups_gss_printf(OM_uint32 major_status
, OM_uint32 minor_status
,
70 # define cups_gss_printf(major, minor, message)
72 #endif /* HAVE_GSSAPI */
73 static int cups_local_auth(http_t
*http
);
77 * 'cupsDoAuthentication()' - Authenticate a request.
79 * This function should be called in response to a @code HTTP_UNAUTHORIZED@
80 * status, prior to resubmitting your request.
82 * @since CUPS 1.1.20/Mac OS X 10.4@
85 int /* O - 0 on success, -1 on error */
86 cupsDoAuthentication(http_t
*http
, /* I - Connection to server or @code CUPS_HTTP_DEFAULT@ */
87 const char *method
,/* I - Request method ("GET", "POST", "PUT") */
89 /* I - Resource path */
91 const char *password
; /* Password string */
92 char prompt
[1024], /* Prompt for user */
93 realm
[HTTP_MAX_VALUE
], /* realm="xyz" string */
94 nonce
[HTTP_MAX_VALUE
]; /* nonce="xyz" string */
95 int localauth
; /* Local authentication result */
96 _cups_globals_t
*cg
; /* Global data */
99 DEBUG_printf(("cupsDoAuthentication(http=%p, method=\"%s\", resource=\"%s\")\n",
100 http
, method
, resource
));
101 DEBUG_printf(("cupsDoAuthentication: digest_tries=%d, userpass=\"%s\"\n",
102 http
->digest_tries
, http
->userpass
));
103 DEBUG_printf(("cupsDoAuthentication: WWW-Authenticate=\"%s\"\n",
104 httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
)));
107 * Clear the current authentication string...
110 httpSetAuthString(http
, NULL
, NULL
);
113 * See if we can do local authentication...
116 if (http
->digest_tries
< 3)
118 if ((localauth
= cups_local_auth(http
)) == 0)
120 DEBUG_printf(("cupsDoAuthentication: authstring=\"%s\"\n",
123 if (http
->status
== HTTP_UNAUTHORIZED
)
124 http
->digest_tries
++;
128 else if (localauth
== -1)
129 return (-1); /* Error or canceled */
133 * Nope, see if we should retry the current username:password...
136 if ((http
->digest_tries
> 1 || !http
->userpass
[0]) &&
137 strncmp(http
->fields
[HTTP_FIELD_WWW_AUTHENTICATE
], "Negotiate", 9))
140 * Nope - get a new password from the user...
145 if (!cg
->lang_default
)
146 cg
->lang_default
= cupsLangDefault();
148 snprintf(prompt
, sizeof(prompt
),
149 _cupsLangString(cg
->lang_default
, _("Password for %s on %s? ")),
151 http
->hostname
[0] == '/' ? "localhost" : http
->hostname
);
153 http
->digest_tries
= strncasecmp(http
->fields
[HTTP_FIELD_WWW_AUTHENTICATE
],
155 http
->userpass
[0] = '\0';
157 if ((password
= cupsGetPassword(prompt
)) == NULL
)
163 snprintf(http
->userpass
, sizeof(http
->userpass
), "%s:%s", cupsUser(),
166 else if (http
->status
== HTTP_UNAUTHORIZED
)
167 http
->digest_tries
++;
170 * Got a password; encode it for the server...
173 if (!strncmp(http
->fields
[HTTP_FIELD_WWW_AUTHENTICATE
], "Negotiate", 9))
177 * Kerberos authentication...
180 OM_uint32 minor_status
, /* Minor status code */
181 major_status
; /* Major status code */
182 gss_buffer_desc output_token
= GSS_C_EMPTY_BUFFER
,
184 input_token
= GSS_C_EMPTY_BUFFER
;
186 char *gss_service_name
;
187 /* GSS service name */
189 const char *authorization
;
190 /* Pointer into Authorization string */
191 # endif /* USE_SPNEGO */
196 * If the weak-linked GSSAPI/Kerberos library is not present, don't try
200 if (gss_init_sec_context
== NULL
)
202 DEBUG_puts("cupsDoAuthentication: Weak-linked GSSAPI/Kerberos framework "
206 # endif /* __APPLE__ */
208 if (http
->status
== HTTP_UNAUTHORIZED
&& http
->digest_tries
>= 3)
210 DEBUG_printf(("cupsDoAuthentication: too many Negotiate tries (%d)\n",
211 http
->digest_tries
));
216 if (http
->gssname
== GSS_C_NO_NAME
)
218 if ((gss_service_name
= getenv("CUPS_GSSSERVICENAME")) == NULL
)
219 gss_service_name
= CUPS_DEFAULT_GSSSERVICENAME
;
221 DEBUG_puts("cupsDoAuthentication: GSS service name set via environment");
223 http
->gssname
= cups_get_gssname(http
, gss_service_name
);
226 # ifdef USE_SPNEGO /* We don't implement SPNEGO just yet... */
228 * Find the start of the Kerberos input token...
231 authorization
= httpGetField(http
, HTTP_FIELD_WWW_AUTHENTICATE
);
234 while (*authorization
&& isspace(*authorization
& 255))
240 * Decode the authorization string to get the input token...
243 int len
= strlen(authorization
);
245 input_token
.value
= malloc(len
);
246 input_token
.value
= httpDecode64_2(input_token
.value
, &len
,
248 input_token
.length
= len
;
252 char *ptr
= (char *)input_token
.value
;
255 fputs("input_token=", stdout
);
259 printf("\\%03o", *ptr
& 255);
269 # endif /* USE_SPNEGO */
271 if (http
->gssctx
!= GSS_C_NO_CONTEXT
)
273 gss_delete_sec_context(&minor_status
, &http
->gssctx
, GSS_C_NO_BUFFER
);
274 http
->gssctx
= GSS_C_NO_CONTEXT
;
277 major_status
= gss_init_sec_context(&minor_status
, GSS_C_NO_CREDENTIAL
,
279 http
->gssname
, http
->gssmech
,
280 #ifdef GSS_C_DELEG_POLICY_FLAG
281 GSS_C_DELEG_POLICY_FLAG
|
282 #endif /* GSS_C_DELEG_POLICY_FLAG */
283 GSS_C_MUTUAL_FLAG
| GSS_C_INTEG_FLAG
,
285 GSS_C_NO_CHANNEL_BINDINGS
,
286 &input_token
, &http
->gssmech
,
287 &output_token
, NULL
, NULL
);
289 if (input_token
.value
)
290 free(input_token
.value
);
292 if (GSS_ERROR(major_status
))
294 cups_gss_printf(major_status
, minor_status
,
295 "Unable to initialize security context");
299 if (major_status
== GSS_S_CONTINUE_NEEDED
)
300 cups_gss_printf(major_status
, minor_status
, "Continuation needed!");
302 if (output_token
.length
> 0 && output_token
.length
<= 65536)
305 * Allocate the authorization string since Windows KDCs can have
306 * arbitrarily large credentials...
309 int authsize
= 10 + /* "Negotiate " */
310 output_token
.length
* 4 / 3 + 1 + /* Base64 */
313 httpSetAuthString(http
, NULL
, NULL
);
315 if ((http
->authstring
= malloc(authsize
)) == NULL
)
317 http
->authstring
= http
->_authstring
;
318 authsize
= sizeof(http
->_authstring
);
321 strcpy(http
->authstring
, "Negotiate ");
322 httpEncode64_2(http
->authstring
+ 10, authsize
- 10, output_token
.value
,
323 output_token
.length
);
325 gss_release_buffer(&minor_status
, &output_token
);
329 DEBUG_printf(("cupsDoAuthentication: Kerberos credentials too large - "
330 "%d bytes!\n", (int)output_token
.length
));
332 gss_release_buffer(&minor_status
, &output_token
);
336 #endif /* HAVE_GSSAPI */
338 else if (strncmp(http
->fields
[HTTP_FIELD_WWW_AUTHENTICATE
], "Digest", 6))
341 * Basic authentication...
344 char encode
[256]; /* Base64 buffer */
347 httpEncode64_2(encode
, sizeof(encode
), http
->userpass
,
348 (int)strlen(http
->userpass
));
349 httpSetAuthString(http
, "Basic", encode
);
354 * Digest authentication...
357 char encode
[33], /* MD5 buffer */
358 digest
[1024]; /* Digest auth data */
361 httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "realm", realm
);
362 httpGetSubField(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "nonce", nonce
);
364 httpMD5(cupsUser(), realm
, strchr(http
->userpass
, ':') + 1, encode
);
365 httpMD5Final(nonce
, method
, resource
, encode
);
366 snprintf(digest
, sizeof(digest
),
367 "username=\"%s\", realm=\"%s\", nonce=\"%s\", uri=\"%s\", "
368 "response=\"%s\"", cupsUser(), realm
, nonce
, resource
, encode
);
369 httpSetAuthString(http
, "Digest", digest
);
372 DEBUG_printf(("cupsDoAuthentication: authstring=\"%s\"\n", http
->authstring
));
380 * 'cups_get_gssname()' - Get CUPS service credentials for authentication.
383 static gss_name_t
/* O - Server name */
385 http_t
*http
, /* I - Connection to server */
386 const char *service_name
) /* I - Service name */
388 gss_buffer_desc token
= GSS_C_EMPTY_BUFFER
;
390 OM_uint32 major_status
, /* Major status code */
391 minor_status
; /* Minor status code */
392 gss_name_t server_name
; /* Server name */
393 char buf
[1024], /* Name buffer */
394 fqdn
[HTTP_MAX_URI
]; /* Server name buffer */
397 DEBUG_printf(("cups_get_gssname(http=%p, service_name=\"%s\")", http
,
402 * Get the hostname...
405 httpGetHostname(http
, fqdn
, sizeof(fqdn
));
407 if (!strcmp(fqdn
, "localhost"))
408 httpGetHostname(NULL
, fqdn
, sizeof(fqdn
));
411 * Get a server name we can use for authentication purposes...
414 snprintf(buf
, sizeof(buf
), "%s@%s", service_name
, fqdn
);
416 DEBUG_printf(("cups_get_gssname: Looking up %s...\n", buf
));
419 token
.length
= strlen(buf
);
420 server_name
= GSS_C_NO_NAME
;
421 major_status
= gss_import_name(&minor_status
, &token
,
422 GSS_C_NT_HOSTBASED_SERVICE
,
425 if (GSS_ERROR(major_status
))
427 cups_gss_printf(major_status
, minor_status
,
428 "cups_get_gssname: gss_import_name() failed");
432 return (server_name
);
438 * 'cups_gss_printf()' - Show debug error messages from GSSAPI...
442 cups_gss_printf(OM_uint32 major_status
,/* I - Major status code */
443 OM_uint32 minor_status
,/* I - Minor status code */
444 const char *message
) /* I - Prefix for error message */
446 OM_uint32 err_major_status
, /* Major status code for display */
447 err_minor_status
; /* Minor status code for display */
448 OM_uint32 msg_ctx
; /* Message context */
449 gss_buffer_desc major_status_string
= GSS_C_EMPTY_BUFFER
,
450 /* Major status message */
451 minor_status_string
= GSS_C_EMPTY_BUFFER
;
452 /* Minor status message */
456 err_major_status
= gss_display_status(&err_minor_status
,
461 &major_status_string
);
463 if (!GSS_ERROR(err_major_status
))
464 gss_display_status(&err_minor_status
, minor_status
, GSS_C_MECH_CODE
,
465 GSS_C_NULL_OID
, &msg_ctx
, &minor_status_string
);
467 DEBUG_printf(("%s: %s, %s", message
, (char *)major_status_string
.value
,
468 (char *)minor_status_string
.value
));
470 gss_release_buffer(&err_minor_status
, &major_status_string
);
471 gss_release_buffer(&err_minor_status
, &minor_status_string
);
474 #endif /* HAVE_GSSAPI */
478 * 'cups_local_auth()' - Get the local authorization certificate if
479 * available/applicable...
482 static int /* O - 0 if available */
483 /* 1 if not available */
485 cups_local_auth(http_t
*http
) /* I - HTTP connection to server */
487 #if defined(WIN32) || defined(__EMX__)
489 * Currently WIN32 and OS-2 do not support the CUPS server...
494 int pid
; /* Current process ID */
495 FILE *fp
; /* Certificate file */
496 char trc
[16], /* Try Root Certificate parameter */
497 filename
[1024], /* Certificate filename */
498 certificate
[33];/* Certificate string */
499 _cups_globals_t
*cg
= _cupsGlobals(); /* Global data */
500 # if defined(HAVE_AUTHORIZATION_H)
501 OSStatus status
; /* Status */
502 AuthorizationItem auth_right
; /* Authorization right */
503 AuthorizationRights auth_rights
; /* Authorization rights */
504 AuthorizationFlags auth_flags
; /* Authorization flags */
505 AuthorizationExternalForm auth_extrn
; /* Authorization ref external */
506 char auth_key
[1024]; /* Buffer */
507 char buffer
[1024]; /* Buffer */
508 # endif /* HAVE_AUTHORIZATION_H */
511 DEBUG_printf(("cups_local_auth(http=%p) hostaddr=%s, hostname=\"%s\"\n",
512 http
, httpAddrString(http
->hostaddr
, filename
, sizeof(filename
)), http
->hostname
));
515 * See if we are accessing localhost...
518 if (!httpAddrLocalhost(http
->hostaddr
) &&
519 strcasecmp(http
->hostname
, "localhost") != 0)
521 DEBUG_puts("cups_local_auth: Not a local connection!");
525 # if defined(HAVE_AUTHORIZATION_H)
527 * Delete any previous authorization reference...
532 AuthorizationFree(http
->auth_ref
, kAuthorizationFlagDefaults
);
533 http
->auth_ref
= NULL
;
536 if (!getenv("GATEWAY_INTERFACE") &&
537 httpGetSubField2(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "authkey",
538 auth_key
, sizeof(auth_key
)))
540 status
= AuthorizationCreate(NULL
, kAuthorizationEmptyEnvironment
,
541 kAuthorizationFlagDefaults
, &http
->auth_ref
);
542 if (status
!= errAuthorizationSuccess
)
544 DEBUG_printf(("cups_local_auth: AuthorizationCreate() returned %d (%s)\n",
545 (int)status
, cssmErrorString(status
)));
549 auth_right
.name
= auth_key
;
550 auth_right
.valueLength
= 0;
551 auth_right
.value
= NULL
;
552 auth_right
.flags
= 0;
554 auth_rights
.count
= 1;
555 auth_rights
.items
= &auth_right
;
557 auth_flags
= kAuthorizationFlagDefaults
|
558 kAuthorizationFlagPreAuthorize
|
559 kAuthorizationFlagInteractionAllowed
|
560 kAuthorizationFlagExtendRights
;
562 status
= AuthorizationCopyRights(http
->auth_ref
, &auth_rights
,
563 kAuthorizationEmptyEnvironment
,
565 if (status
== errAuthorizationSuccess
)
566 status
= AuthorizationMakeExternalForm(http
->auth_ref
, &auth_extrn
);
568 if (status
== errAuthorizationSuccess
)
571 * Set the authorization string and return...
574 httpEncode64_2(buffer
, sizeof(buffer
), (void *)&auth_extrn
,
577 httpSetAuthString(http
, "AuthRef", buffer
);
579 DEBUG_printf(("cups_local_auth: Returning authstring = \"%s\"\n",
583 else if (status
== errAuthorizationCanceled
)
586 DEBUG_printf(("cups_local_auth: AuthorizationCopyRights() returned %d (%s)\n",
587 (int)status
, cssmErrorString(status
)));
590 * Fall through to try certificates...
593 # endif /* HAVE_AUTHORIZATION_H */
596 * Try opening a certificate file for this PID. If that fails,
597 * try the root certificate...
601 snprintf(filename
, sizeof(filename
), "%s/certs/%d", cg
->cups_statedir
, pid
);
602 if ((fp
= fopen(filename
, "r")) == NULL
&& pid
> 0)
605 * No certificate for this PID; see if we can get the root certificate...
608 DEBUG_printf(("cups_local_auth: Unable to open file %s: %s\n",
609 filename
, strerror(errno
)));
612 if (!strncmp(http
->fields
[HTTP_FIELD_WWW_AUTHENTICATE
], "Negotiate", 9))
615 * Kerberos required, don't try the root certificate...
620 #endif /* HAVE_GSSAPI */
622 if (!httpGetSubField2(http
, HTTP_FIELD_WWW_AUTHENTICATE
, "trc", trc
,
626 * Scheduler doesn't want us to use the root certificate...
632 snprintf(filename
, sizeof(filename
), "%s/certs/0", cg
->cups_statedir
);
633 fp
= fopen(filename
, "r");
639 * Read the certificate from the file...
642 fgets(certificate
, sizeof(certificate
), fp
);
646 * Set the authorization string and return...
649 httpSetAuthString(http
, "Local", certificate
);
651 DEBUG_printf(("cups_local_auth: Returning authstring = \"%s\"\n",
657 # if defined(SO_PEERCRED) && defined(AF_LOCAL)
659 * See if we can authenticate using the peer credentials provided over a
660 * domain socket; if so, specify "PeerCred username" as the authentication
664 if (http
->hostaddr
->addr
.sa_family
== AF_LOCAL
&&
665 !getenv("GATEWAY_INTERFACE")) /* Not via CGI programs... */
668 * Verify that the current cupsUser() matches the current UID...
671 struct passwd
*pwd
; /* Password information */
672 const char *username
; /* Current username */
674 username
= cupsUser();
676 if ((pwd
= getpwnam(username
)) != NULL
&& pwd
->pw_uid
== getuid())
678 httpSetAuthString(http
, "PeerCred", username
);
680 DEBUG_printf(("cups_local_auth: Returning authstring = \"%s\"\n",
686 # endif /* SO_PEERCRED && AF_LOCAL */
689 #endif /* WIN32 || __EMX__ */