2 * "$Id: http.c 7850 2008-08-20 00:07:25Z mike $"
4 * HTTP routines for CUPS.
6 * Copyright 2007-2012 by Apple Inc.
7 * Copyright 1997-2007 by Easy Software Products, all rights reserved.
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 * httpAddCredential() - Allocates and adds a single credential to an
24 * _httpBIOMethods() - Get the OpenSSL BIO methods for HTTP
26 * httpBlocking() - Set blocking/non-blocking behavior on a
28 * httpCheck() - Check to see if there is a pending response
30 * httpClearCookie() - Clear the cookie value(s).
31 * httpClearFields() - Clear HTTP request fields.
32 * httpClose() - Close an HTTP connection.
33 * httpConnect() - Connect to a HTTP server.
34 * httpConnectEncrypt() - Connect to a HTTP server using encryption.
35 * httpCopyCredentials() - Copy the credentials associated with an
36 * encrypted connection.
37 * _httpCreate() - Create an unconnected HTTP connection.
38 * _httpCreateCredentials() - Create credentials in the internal format.
39 * httpDelete() - Send a DELETE request to the server.
40 * _httpDisconnect() - Disconnect a HTTP connection.
41 * httpEncryption() - Set the required encryption on the link.
42 * httpError() - Get the last error on a connection.
43 * httpFlush() - Flush data from a HTTP connection.
44 * httpFlushWrite() - Flush data in write buffer.
45 * _httpFreeCredentials() - Free internal credentials.
46 * httpFreeCredentials() - Free an array of credentials.
47 * httpGet() - Send a GET request to the server.
48 * httpGetAuthString() - Get the current authorization string.
49 * httpGetBlocking() - Get the blocking/non-block state of a
51 * httpGetCookie() - Get any cookie data from the response.
52 * httpGetFd() - Get the file descriptor associated with a
54 * httpGetField() - Get a field value from a request/response.
55 * httpGetLength() - Get the amount of data remaining from the
56 * content-length or transfer-encoding fields.
57 * httpGetLength2() - Get the amount of data remaining from the
58 * content-length or transfer-encoding fields.
59 * httpGets() - Get a line of text from a HTTP connection.
60 * httpGetState() - Get the current state of the HTTP request.
61 * httpGetStatus() - Get the status of the last HTTP request.
62 * httpGetSubField() - Get a sub-field value.
63 * httpGetSubField2() - Get a sub-field value.
64 * httpGetVersion() - Get the HTTP version at the other end.
65 * httpHead() - Send a HEAD request to the server.
66 * httpInitialize() - Initialize the HTTP interface library and set
67 * the default HTTP proxy (if any).
68 * httpOptions() - Send an OPTIONS request to the server.
69 * _httpPeek() - Peek at data from a HTTP connection.
70 * httpPost() - Send a POST request to the server.
71 * httpPrintf() - Print a formatted string to a HTTP connection.
72 * httpPut() - Send a PUT request to the server.
73 * httpRead() - Read data from a HTTP connection.
74 * httpRead2() - Read data from a HTTP connection.
75 * _httpReadCDSA() - Read function for the CDSA library.
76 * _httpReadGNUTLS() - Read function for the GNU TLS library.
77 * httpReconnect() - Reconnect to a HTTP server.
78 * httpReconnect2() - Reconnect to a HTTP server with timeout and
80 * httpSetAuthString() - Set the current authorization string.
81 * httpSetCredentials() - Set the credentials associated with an
82 * encrypted connection.
83 * httpSetCookie() - Set the cookie value(s).
84 * httpSetExpect() - Set the Expect: header in a request.
85 * httpSetField() - Set the value of an HTTP header.
86 * httpSetLength() - Set the content-length and content-encoding.
87 * httpSetTimeout() - Set read/write timeouts and an optional
89 * httpTrace() - Send an TRACE request to the server.
90 * _httpUpdate() - Update the current HTTP status for incoming
92 * httpUpdate() - Update the current HTTP state for incoming
94 * _httpWait() - Wait for data available on a connection (no
96 * httpWait() - Wait for data available on a connection.
97 * httpWrite() - Write data to a HTTP connection.
98 * httpWrite2() - Write data to a HTTP connection.
99 * _httpWriteCDSA() - Write function for the CDSA library.
100 * _httpWriteGNUTLS() - Write function for the GNU TLS library.
101 * http_bio_ctrl() - Control the HTTP connection.
102 * http_bio_free() - Free OpenSSL data.
103 * http_bio_new() - Initialize an OpenSSL BIO structure.
104 * http_bio_puts() - Send a string for OpenSSL.
105 * http_bio_read() - Read data for OpenSSL.
106 * http_bio_write() - Write data for OpenSSL.
107 * http_debug_hex() - Do a hex dump of a buffer.
108 * http_field() - Return the field index for a field name.
109 * http_read_ssl() - Read from a SSL/TLS connection.
110 * http_send() - Send a request with all fields and the trailing
112 * http_set_credentials() - Set the SSL/TLS credentials.
113 * http_set_timeout() - Set the socket timeout values.
114 * http_set_wait() - Set the default wait value for reads.
115 * http_setup_ssl() - Set up SSL/TLS support on a connection.
116 * http_shutdown_ssl() - Shut down SSL/TLS on a connection.
117 * http_upgrade() - Force upgrade to TLS encryption.
118 * http_write() - Write a buffer to a HTTP connection.
119 * http_write_chunk() - Write a chunked buffer.
120 * http_write_ssl() - Write to a SSL/TLS connection.
124 * Include necessary headers...
127 #include "cups-private.h"
134 # include <sys/time.h>
135 # include <sys/resource.h>
139 #endif /* HAVE_POLL */
147 static void http_debug_hex(const char *prefix
, const char *buffer
,
150 static http_field_t
http_field(const char *name
);
151 static int http_send(http_t
*http
, http_state_t request
,
153 static int http_write(http_t
*http
, const char *buffer
,
155 static int http_write_chunk(http_t
*http
, const char *buffer
,
158 static int http_read_ssl(http_t
*http
, char *buf
, int len
);
159 # if defined(HAVE_CDSASSL) && defined(HAVE_SECCERTIFICATECOPYDATA)
160 static int http_set_credentials(http_t
*http
);
161 # endif /* HAVE_CDSASSL ** HAVE_SECCERTIFICATECOPYDATA */
162 #endif /* HAVE_SSL */
163 static void http_set_timeout(int fd
, double timeout
);
164 static void http_set_wait(http_t
*http
);
166 static int http_setup_ssl(http_t
*http
);
167 static void http_shutdown_ssl(http_t
*http
);
168 static int http_upgrade(http_t
*http
);
169 static int http_write_ssl(http_t
*http
, const char *buf
, int len
);
170 #endif /* HAVE_SSL */
177 static const char * const http_fields
[] =
194 "If-Unmodified-since",
208 static const char * const http_states
[] =
228 #if defined(HAVE_SSL) && defined(HAVE_LIBSSL)
230 * BIO methods for OpenSSL...
233 static int http_bio_write(BIO
*h
, const char *buf
, int num
);
234 static int http_bio_read(BIO
*h
, char *buf
, int size
);
235 static int http_bio_puts(BIO
*h
, const char *str
);
236 static long http_bio_ctrl(BIO
*h
, int cmd
, long arg1
, void *arg2
);
237 static int http_bio_new(BIO
*h
);
238 static int http_bio_free(BIO
*data
);
240 static BIO_METHOD http_bio_methods
=
247 NULL
, /* http_bio_gets, */
253 #endif /* HAVE_SSL && HAVE_LIBSSL */
257 * 'httpAddCredential()' - Allocates and adds a single credential to an array.
259 * Use @code cupsArrayNew(NULL, NULL)@ to create a credentials array.
261 * @since CUPS 1.5/Mac OS X 10.7@
264 int /* O - 0 on success, -1 on error */
266 cups_array_t
*credentials
, /* I - Credentials array */
267 const void *data
, /* I - PEM-encoded X.509 data */
268 size_t datalen
) /* I - Length of data */
270 http_credential_t
*credential
; /* Credential data */
273 if ((credential
= malloc(sizeof(http_credential_t
))) != NULL
)
275 credential
->datalen
= datalen
;
277 if ((credential
->data
= malloc(datalen
)) != NULL
)
279 memcpy(credential
->data
, data
, datalen
);
280 cupsArrayAdd(credentials
, credential
);
291 #if defined(HAVE_SSL) && defined(HAVE_LIBSSL)
293 * '_httpBIOMethods()' - Get the OpenSSL BIO methods for HTTP connections.
296 BIO_METHOD
* /* O - BIO methods for OpenSSL */
297 _httpBIOMethods(void)
299 return (&http_bio_methods
);
301 #endif /* HAVE_SSL && HAVE_LIBSSL */
305 * 'httpBlocking()' - Set blocking/non-blocking behavior on a connection.
309 httpBlocking(http_t
*http
, /* I - Connection to server */
310 int b
) /* I - 1 = blocking, 0 = non-blocking */
321 * 'httpCheck()' - Check to see if there is a pending response from the server.
324 int /* O - 0 = no data, 1 = data available */
325 httpCheck(http_t
*http
) /* I - Connection to server */
327 return (httpWait(http
, 0));
332 * 'httpClearCookie()' - Clear the cookie value(s).
334 * @since CUPS 1.1.19/Mac OS X 10.3@
338 httpClearCookie(http_t
*http
) /* I - Connection to server */
352 * 'httpClearFields()' - Clear HTTP request fields.
356 httpClearFields(http_t
*http
) /* I - Connection to server */
360 memset(http
->fields
, 0, sizeof(http
->fields
));
361 if (http
->hostname
[0] == '/')
362 httpSetField(http
, HTTP_FIELD_HOST
, "localhost");
364 httpSetField(http
, HTTP_FIELD_HOST
, http
->hostname
);
366 if (http
->field_authorization
)
368 free(http
->field_authorization
);
369 http
->field_authorization
= NULL
;
372 http
->expect
= (http_status_t
)0;
378 * 'httpClose()' - Close an HTTP connection.
382 httpClose(http_t
*http
) /* I - Connection to server */
385 OM_uint32 minor_status
; /* Minor status code */
386 #endif /* HAVE_GSSAPI */
389 DEBUG_printf(("httpClose(http=%p)", http
));
392 * Range check input...
399 * Close any open connection...
402 _httpDisconnect(http
);
405 * Free memory used...
408 httpAddrFreeList(http
->addrlist
);
414 if (http
->gssctx
!= GSS_C_NO_CONTEXT
)
415 gss_delete_sec_context(&minor_status
, &http
->gssctx
, GSS_C_NO_BUFFER
);
417 if (http
->gssname
!= GSS_C_NO_NAME
)
418 gss_release_name(&minor_status
, &http
->gssname
);
419 #endif /* HAVE_GSSAPI */
421 #ifdef HAVE_AUTHORIZATION_H
423 AuthorizationFree(http
->auth_ref
, kAuthorizationFlagDefaults
);
424 #endif /* HAVE_AUTHORIZATION_H */
426 httpClearFields(http
);
428 if (http
->authstring
&& http
->authstring
!= http
->_authstring
)
429 free(http
->authstring
);
436 * 'httpConnect()' - Connect to a HTTP server.
438 * This function is deprecated - use @link httpConnectEncrypt@ instead.
443 http_t
* /* O - New HTTP connection */
444 httpConnect(const char *host
, /* I - Host to connect to */
445 int port
) /* I - Port number */
447 return (httpConnectEncrypt(host
, port
, HTTP_ENCRYPT_IF_REQUESTED
));
452 * 'httpConnectEncrypt()' - Connect to a HTTP server using encryption.
455 http_t
* /* O - New HTTP connection */
457 const char *host
, /* I - Host to connect to */
458 int port
, /* I - Port number */
459 http_encryption_t encryption
) /* I - Type of encryption to use */
461 http_t
*http
; /* New HTTP connection */
464 DEBUG_printf(("httpConnectEncrypt(host=\"%s\", port=%d, encryption=%d)",
465 host
, port
, encryption
));
468 * Create the HTTP structure...
471 if ((http
= _httpCreate(host
, port
, NULL
, encryption
, AF_UNSPEC
)) == NULL
)
475 * Connect to the remote system...
478 if (!httpReconnect(http
))
482 * Could not connect to any known address - bail out!
485 httpAddrFreeList(http
->addrlist
);
494 * 'httpCopyCredentials()' - Copy the credentials associated with an encrypted
497 * @since CUPS 1.5/Mac OS X 10.7@
500 int /* O - Status of call (0 = success) */
502 http_t
*http
, /* I - Connection to server */
503 cups_array_t
**credentials
) /* O - Array of credentials */
506 # elif defined(HAVE_GNUTLS)
507 # elif defined(HAVE_CDSASSL) && defined(HAVE_SECCERTIFICATECOPYDATA)
508 OSStatus error
; /* Error code */
509 CFIndex count
; /* Number of credentials */
510 CFArrayRef peerCerts
; /* Peer certificates */
511 SecCertificateRef secCert
; /* Certificate reference */
512 CFDataRef data
; /* Certificate data */
513 int i
; /* Looping var */
514 # elif defined(HAVE_SSPISSL)
515 # endif /* HAVE_LIBSSL */
521 if (!http
|| !http
->tls
|| !credentials
)
527 # elif defined(HAVE_GNUTLS)
530 # elif defined(HAVE_CDSASSL) && defined(HAVE_SECCERTIFICATECOPYDATA)
531 if (!(error
= SSLCopyPeerCertificates(http
->tls
, &peerCerts
)) && peerCerts
)
533 if ((*credentials
= cupsArrayNew(NULL
, NULL
)) != NULL
)
535 for (i
= 0, count
= CFArrayGetCount(peerCerts
); i
< count
; i
++)
537 secCert
= (SecCertificateRef
)CFArrayGetValueAtIndex(peerCerts
, i
);
538 if ((data
= SecCertificateCopyData(secCert
)))
540 httpAddCredential(*credentials
, CFDataGetBytePtr(data
),
541 CFDataGetLength(data
));
547 CFRelease(peerCerts
);
552 # elif defined(HAVE_SSPISSL)
557 # endif /* HAVE_LIBSSL */
562 * '_httpCreate()' - Create an unconnected HTTP connection.
565 http_t
* /* O - HTTP connection */
567 const char *host
, /* I - Hostname */
568 int port
, /* I - Port number */
569 http_addrlist_t
*addrlist
, /* I - Address list or NULL */
570 http_encryption_t encryption
, /* I - Encryption to use */
571 int family
) /* I - Address family or AF_UNSPEC */
573 http_t
*http
; /* New HTTP connection */
574 char service
[255]; /* Service name */
577 DEBUG_printf(("4_httpCreate(host=\"%s\", port=%d, encryption=%d)",
578 host
, port
, encryption
));
589 sprintf(service
, "%d", port
);
592 if ((addrlist
= httpAddrGetList(host
, family
, service
)) == NULL
)
596 * Allocate memory for the structure...
599 if ((http
= calloc(sizeof(http_t
), 1)) == NULL
)
601 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(errno
), 0);
602 httpAddrFreeList(addrlist
);
607 * Initialize the HTTP data...
610 http
->activity
= time(NULL
);
611 http
->addrlist
= addrlist
;
615 http
->gssctx
= GSS_C_NO_CONTEXT
;
616 http
->gssname
= GSS_C_NO_NAME
;
617 #endif /* HAVE_GSSAPI */
618 http
->version
= HTTP_1_1
;
620 strlcpy(http
->hostname
, host
, sizeof(http
->hostname
));
622 if (port
== 443) /* Always use encryption for https */
623 http
->encryption
= HTTP_ENCRYPT_ALWAYS
;
625 http
->encryption
= encryption
;
630 * Return the new structure...
638 * '_httpCreateCredentials()' - Create credentials in the internal format.
641 http_tls_credentials_t
/* O - Internal credentials */
642 _httpCreateCredentials(
643 cups_array_t
*credentials
) /* I - Array of credentials */
651 # elif defined(HAVE_GNUTLS)
654 # elif defined(HAVE_CDSASSL) && defined(HAVE_SECCERTIFICATECOPYDATA)
655 CFMutableArrayRef peerCerts
; /* Peer credentials reference */
656 SecCertificateRef secCert
; /* Certificate reference */
657 CFDataRef data
; /* Credential data reference */
658 http_credential_t
*credential
; /* Credential data */
661 if ((peerCerts
= CFArrayCreateMutable(kCFAllocatorDefault
,
662 cupsArrayCount(credentials
),
663 &kCFTypeArrayCallBacks
)) == NULL
)
666 for (credential
= (http_credential_t
*)cupsArrayFirst(credentials
);
668 credential
= (http_credential_t
*)cupsArrayNext(credentials
))
670 if ((data
= CFDataCreate(kCFAllocatorDefault
, credential
->data
,
671 credential
->datalen
)))
673 if ((secCert
= SecCertificateCreateWithData(kCFAllocatorDefault
, data
))
676 CFArrayAppendValue(peerCerts
, secCert
);
686 # elif defined(HAVE_SSPISSL)
691 # endif /* HAVE_LIBSSL */
696 * 'httpDelete()' - Send a DELETE request to the server.
699 int /* O - Status of call (0 = success) */
700 httpDelete(http_t
*http
, /* I - Connection to server */
701 const char *uri
) /* I - URI to delete */
703 return (http_send(http
, HTTP_DELETE
, uri
));
708 * '_httpDisconnect()' - Disconnect a HTTP connection.
712 _httpDisconnect(http_t
*http
) /* I - Connection to server */
716 http_shutdown_ssl(http
);
717 #endif /* HAVE_SSL */
720 closesocket(http
->fd
);
730 * 'httpEncryption()' - Set the required encryption on the link.
733 int /* O - -1 on error, 0 on success */
734 httpEncryption(http_t
*http
, /* I - Connection to server */
735 http_encryption_t e
) /* I - New encryption preference */
737 DEBUG_printf(("httpEncryption(http=%p, e=%d)", http
, e
));
743 http
->encryption
= e
;
745 if ((http
->encryption
== HTTP_ENCRYPT_ALWAYS
&& !http
->tls
) ||
746 (http
->encryption
== HTTP_ENCRYPT_NEVER
&& http
->tls
))
747 return (httpReconnect(http
));
748 else if (http
->encryption
== HTTP_ENCRYPT_REQUIRED
&& !http
->tls
)
749 return (http_upgrade(http
));
753 if (e
== HTTP_ENCRYPT_ALWAYS
|| e
== HTTP_ENCRYPT_REQUIRED
)
757 #endif /* HAVE_SSL */
762 * 'httpError()' - Get the last error on a connection.
765 int /* O - Error code (errno) value */
766 httpError(http_t
*http
) /* I - Connection to server */
769 return (http
->error
);
776 * 'httpFlush()' - Flush data from a HTTP connection.
780 httpFlush(http_t
*http
) /* I - Connection to server */
782 char buffer
[8192]; /* Junk buffer */
783 int blocking
; /* To block or not to block */
784 http_state_t oldstate
; /* Old state */
787 DEBUG_printf(("httpFlush(http=%p), state=%s", http
,
788 http_states
[http
->state
]));
791 * Temporarily set non-blocking mode so we don't get stuck in httpRead()...
794 blocking
= http
->blocking
;
798 * Read any data we can...
801 oldstate
= http
->state
;
802 while (httpRead2(http
, buffer
, sizeof(buffer
)) > 0);
805 * Restore blocking and reset the connection if we didn't get all of
806 * the remaining data...
809 http
->blocking
= blocking
;
811 if (http
->state
== oldstate
&& http
->state
!= HTTP_WAITING
&& http
->fd
>= 0)
814 * Didn't get the data back, so close the current connection.
817 http
->state
= HTTP_WAITING
;
821 http_shutdown_ssl(http
);
822 #endif /* HAVE_SSL */
825 closesocket(http
->fd
);
836 * 'httpFlushWrite()' - Flush data in write buffer.
838 * @since CUPS 1.2/Mac OS X 10.5@
841 int /* O - Bytes written or -1 on error */
842 httpFlushWrite(http_t
*http
) /* I - Connection to server */
844 int bytes
; /* Bytes written */
847 DEBUG_printf(("httpFlushWrite(http=%p)", http
));
849 if (!http
|| !http
->wused
)
851 DEBUG_puts(http
? "1httpFlushWrite: Write buffer is empty." :
852 "1httpFlushWrite: No connection.");
856 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
857 bytes
= http_write_chunk(http
, http
->wbuffer
, http
->wused
);
859 bytes
= http_write(http
, http
->wbuffer
, http
->wused
);
863 DEBUG_printf(("1httpFlushWrite: Returning %d, errno=%d.", bytes
, errno
));
870 * '_httpFreeCredentials()' - Free internal credentials.
874 _httpFreeCredentials(
875 http_tls_credentials_t credentials
) /* I - Internal credentials */
883 #elif defined(HAVE_GNUTLS)
886 #elif defined(HAVE_CDSASSL)
887 CFRelease(credentials
);
889 #elif defined(HAVE_SSPISSL)
892 #endif /* HAVE_LIBSSL */
897 * 'httpFreeCredentials()' - Free an array of credentials.
902 cups_array_t
*credentials
) /* I - Array of credentials */
904 http_credential_t
*credential
; /* Credential */
907 for (credential
= (http_credential_t
*)cupsArrayFirst(credentials
);
909 credential
= (http_credential_t
*)cupsArrayNext(credentials
))
911 cupsArrayRemove(credentials
, credential
);
912 free((void *)credential
->data
);
916 cupsArrayDelete(credentials
);
921 * 'httpGet()' - Send a GET request to the server.
924 int /* O - Status of call (0 = success) */
925 httpGet(http_t
*http
, /* I - Connection to server */
926 const char *uri
) /* I - URI to get */
928 return (http_send(http
, HTTP_GET
, uri
));
933 * 'httpGetAuthString()' - Get the current authorization string.
935 * The authorization string is set by cupsDoAuthentication() and
936 * httpSetAuthString(). Use httpGetAuthString() to retrieve the
937 * string to use with httpSetField() for the HTTP_FIELD_AUTHORIZATION
940 * @since CUPS 1.3/Mac OS X 10.5@
943 char * /* O - Authorization string */
944 httpGetAuthString(http_t
*http
) /* I - Connection to server */
947 return (http
->authstring
);
954 * 'httpGetBlocking()' - Get the blocking/non-block state of a connection.
956 * @since CUPS 1.2/Mac OS X 10.5@
959 int /* O - 1 if blocking, 0 if non-blocking */
960 httpGetBlocking(http_t
*http
) /* I - Connection to server */
962 return (http
? http
->blocking
: 0);
967 * 'httpGetCookie()' - Get any cookie data from the response.
969 * @since CUPS 1.1.19/Mac OS X 10.3@
972 const char * /* O - Cookie data or NULL */
973 httpGetCookie(http_t
*http
) /* I - HTTP connecion */
975 return (http
? http
->cookie
: NULL
);
980 * 'httpGetFd()' - Get the file descriptor associated with a connection.
982 * @since CUPS 1.2/Mac OS X 10.5@
985 int /* O - File descriptor or -1 if none */
986 httpGetFd(http_t
*http
) /* I - Connection to server */
988 return (http
? http
->fd
: -1);
993 * 'httpGetField()' - Get a field value from a request/response.
996 const char * /* O - Field value */
997 httpGetField(http_t
*http
, /* I - Connection to server */
998 http_field_t field
) /* I - Field to get */
1000 if (!http
|| field
<= HTTP_FIELD_UNKNOWN
|| field
>= HTTP_FIELD_MAX
)
1002 else if (field
== HTTP_FIELD_AUTHORIZATION
&&
1003 http
->field_authorization
)
1006 * Special case for WWW-Authenticate: as its contents can be
1007 * longer than HTTP_MAX_VALUE...
1010 return (http
->field_authorization
);
1013 return (http
->fields
[field
]);
1018 * 'httpGetLength()' - Get the amount of data remaining from the
1019 * content-length or transfer-encoding fields.
1021 * This function is deprecated and will not return lengths larger than
1022 * 2^31 - 1; use httpGetLength2() instead.
1027 int /* O - Content length */
1028 httpGetLength(http_t
*http
) /* I - Connection to server */
1031 * Get the read content length and return the 32-bit value.
1036 httpGetLength2(http
);
1038 return (http
->_data_remaining
);
1046 * 'httpGetLength2()' - Get the amount of data remaining from the
1047 * content-length or transfer-encoding fields.
1049 * This function returns the complete content length, even for
1050 * content larger than 2^31 - 1.
1052 * @since CUPS 1.2/Mac OS X 10.5@
1055 off_t
/* O - Content length */
1056 httpGetLength2(http_t
*http
) /* I - Connection to server */
1058 DEBUG_printf(("2httpGetLength2(http=%p), state=%s", http
,
1059 http_states
[http
->state
]));
1064 if (!_cups_strcasecmp(http
->fields
[HTTP_FIELD_TRANSFER_ENCODING
], "chunked"))
1066 DEBUG_puts("4httpGetLength2: chunked request!");
1068 http
->data_encoding
= HTTP_ENCODE_CHUNKED
;
1069 http
->data_remaining
= 0;
1073 http
->data_encoding
= HTTP_ENCODE_LENGTH
;
1076 * The following is a hack for HTTP servers that don't send a
1077 * content-length or transfer-encoding field...
1079 * If there is no content-length then the connection must close
1080 * after the transfer is complete...
1083 if (!http
->fields
[HTTP_FIELD_CONTENT_LENGTH
][0])
1086 * Default content length is 0 for errors and 2^31-1 for other
1087 * successful requests...
1090 if (http
->status
>= HTTP_MULTIPLE_CHOICES
)
1091 http
->data_remaining
= 0;
1093 http
->data_remaining
= 2147483647;
1096 http
->data_remaining
= strtoll(http
->fields
[HTTP_FIELD_CONTENT_LENGTH
],
1099 DEBUG_printf(("4httpGetLength2: content_length=" CUPS_LLFMT
,
1100 CUPS_LLCAST http
->data_remaining
));
1103 if (http
->data_remaining
<= INT_MAX
)
1104 http
->_data_remaining
= (int)http
->data_remaining
;
1106 http
->_data_remaining
= INT_MAX
;
1108 return (http
->data_remaining
);
1113 * 'httpGets()' - Get a line of text from a HTTP connection.
1116 char * /* O - Line or NULL */
1117 httpGets(char *line
, /* I - Line to read into */
1118 int length
, /* I - Max length of buffer */
1119 http_t
*http
) /* I - Connection to server */
1121 char *lineptr
, /* Pointer into line */
1122 *lineend
, /* End of line */
1123 *bufptr
, /* Pointer into input buffer */
1124 *bufend
; /* Pointer to end of buffer */
1125 int bytes
, /* Number of bytes read */
1126 eol
; /* End-of-line? */
1129 DEBUG_printf(("2httpGets(line=%p, length=%d, http=%p)", line
, length
, http
));
1131 if (http
== NULL
|| line
== NULL
)
1135 * Read a line from the buffer...
1140 lineend
= line
+ length
- 1;
1143 while (lineptr
< lineend
)
1146 * Pre-load the buffer as needed...
1155 while (http
->used
== 0)
1158 * No newline; see if there is more data to be read...
1161 while (!_httpWait(http
, http
->wait_value
, 1))
1163 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
1166 DEBUG_puts("3httpGets: Timed out!");
1168 http
->error
= WSAETIMEDOUT
;
1170 http
->error
= ETIMEDOUT
;
1177 bytes
= http_read_ssl(http
, http
->buffer
+ http
->used
,
1178 HTTP_MAX_BUFFER
- http
->used
);
1180 #endif /* HAVE_SSL */
1181 bytes
= recv(http
->fd
, http
->buffer
+ http
->used
,
1182 HTTP_MAX_BUFFER
- http
->used
, 0);
1184 DEBUG_printf(("4httpGets: read %d bytes...", bytes
));
1187 http_debug_hex("httpGets", http
->buffer
+ http
->used
, bytes
);
1193 * Nope, can't get a line this time...
1197 DEBUG_printf(("3httpGets: recv() error %d!", WSAGetLastError()));
1199 if (WSAGetLastError() == WSAEINTR
)
1201 else if (WSAGetLastError() == WSAEWOULDBLOCK
)
1203 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
1206 http
->error
= WSAGetLastError();
1208 else if (WSAGetLastError() != http
->error
)
1210 http
->error
= WSAGetLastError();
1215 DEBUG_printf(("3httpGets: recv() error %d!", errno
));
1219 else if (errno
== EWOULDBLOCK
|| errno
== EAGAIN
)
1221 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
1223 else if (!http
->timeout_cb
&& errno
== EAGAIN
)
1226 http
->error
= errno
;
1228 else if (errno
!= http
->error
)
1230 http
->error
= errno
;
1237 else if (bytes
== 0)
1239 http
->error
= EPIPE
;
1245 * Yup, update the amount used...
1248 http
->used
+= bytes
;
1252 * Now copy as much of the current line as possible...
1255 for (bufptr
= http
->buffer
, bufend
= http
->buffer
+ http
->used
;
1256 lineptr
< lineend
&& bufptr
< bufend
;)
1258 if (*bufptr
== 0x0a)
1264 else if (*bufptr
== 0x0d)
1267 *lineptr
++ = *bufptr
++;
1270 http
->used
-= (int)(bufptr
- http
->buffer
);
1272 memmove(http
->buffer
, bufptr
, http
->used
);
1280 http
->activity
= time(NULL
);
1284 DEBUG_printf(("3httpGets: Returning \"%s\"", line
));
1290 DEBUG_puts("3httpGets: No new line available!");
1297 * 'httpGetState()' - Get the current state of the HTTP request.
1300 http_state_t
/* O - HTTP state */
1301 httpGetState(http_t
*http
) /* I - Connection to server */
1303 return (http
? http
->state
: HTTP_ERROR
);
1308 * 'httpGetStatus()' - Get the status of the last HTTP request.
1310 * @since CUPS 1.2/Mac OS X 10.5@
1313 http_status_t
/* O - HTTP status */
1314 httpGetStatus(http_t
*http
) /* I - Connection to server */
1316 return (http
? http
->status
: HTTP_ERROR
);
1321 * 'httpGetSubField()' - Get a sub-field value.
1326 char * /* O - Value or NULL */
1327 httpGetSubField(http_t
*http
, /* I - Connection to server */
1328 http_field_t field
, /* I - Field index */
1329 const char *name
, /* I - Name of sub-field */
1330 char *value
) /* O - Value string */
1332 return (httpGetSubField2(http
, field
, name
, value
, HTTP_MAX_VALUE
));
1337 * 'httpGetSubField2()' - Get a sub-field value.
1339 * @since CUPS 1.2/Mac OS X 10.5@
1342 char * /* O - Value or NULL */
1343 httpGetSubField2(http_t
*http
, /* I - Connection to server */
1344 http_field_t field
, /* I - Field index */
1345 const char *name
, /* I - Name of sub-field */
1346 char *value
, /* O - Value string */
1347 int valuelen
) /* I - Size of value buffer */
1349 const char *fptr
; /* Pointer into field */
1350 char temp
[HTTP_MAX_VALUE
], /* Temporary buffer for name */
1351 *ptr
, /* Pointer into string buffer */
1352 *end
; /* End of value buffer */
1354 DEBUG_printf(("2httpGetSubField2(http=%p, field=%d, name=\"%s\", value=%p, "
1355 "valuelen=%d)", http
, field
, name
, value
, valuelen
));
1357 if (!http
|| !name
|| !value
|| valuelen
< 2 ||
1358 field
<= HTTP_FIELD_UNKNOWN
|| field
>= HTTP_FIELD_MAX
)
1361 end
= value
+ valuelen
- 1;
1363 for (fptr
= http
->fields
[field
]; *fptr
;)
1366 * Skip leading whitespace...
1369 while (_cups_isspace(*fptr
))
1379 * Get the sub-field name...
1383 *fptr
&& *fptr
!= '=' && !_cups_isspace(*fptr
) &&
1384 ptr
< (temp
+ sizeof(temp
) - 1);
1389 DEBUG_printf(("4httpGetSubField2: name=\"%s\"", temp
));
1392 * Skip trailing chars up to the '='...
1395 while (_cups_isspace(*fptr
))
1405 * Skip = and leading whitespace...
1410 while (_cups_isspace(*fptr
))
1416 * Read quoted string...
1419 for (ptr
= value
, fptr
++;
1420 *fptr
&& *fptr
!= '\"' && ptr
< end
;
1425 while (*fptr
&& *fptr
!= '\"')
1434 * Read unquoted string...
1438 *fptr
&& !_cups_isspace(*fptr
) && *fptr
!= ',' && ptr
< end
;
1443 while (*fptr
&& !_cups_isspace(*fptr
) && *fptr
!= ',')
1447 DEBUG_printf(("4httpGetSubField2: value=\"%s\"", value
));
1450 * See if this is the one...
1453 if (!strcmp(name
, temp
))
1455 DEBUG_printf(("3httpGetSubField2: Returning \"%s\"", value
));
1462 DEBUG_puts("3httpGetSubField2: Returning NULL");
1469 * 'httpGetVersion()' - Get the HTTP version at the other end.
1472 http_version_t
/* O - Version number */
1473 httpGetVersion(http_t
*http
) /* I - Connection to server */
1475 return (http
? http
->version
: HTTP_1_0
);
1480 * 'httpHead()' - Send a HEAD request to the server.
1483 int /* O - Status of call (0 = success) */
1484 httpHead(http_t
*http
, /* I - Connection to server */
1485 const char *uri
) /* I - URI for head */
1487 DEBUG_printf(("httpHead(http=%p, uri=\"%s\")", http
, uri
));
1488 return (http_send(http
, HTTP_HEAD
, uri
));
1493 * 'httpInitialize()' - Initialize the HTTP interface library and set the
1494 * default HTTP proxy (if any).
1498 httpInitialize(void)
1500 static int initialized
= 0; /* Have we been called before? */
1502 WSADATA winsockdata
; /* WinSock data */
1505 int i
; /* Looping var */
1506 unsigned char data
[1024]; /* Seed data */
1507 #endif /* HAVE_LIBSSL */
1513 _cupsGlobalUnlock();
1518 WSAStartup(MAKEWORD(2,2), &winsockdata
);
1520 #elif !defined(SO_NOSIGPIPE)
1522 * Ignore SIGPIPE signals...
1526 sigset(SIGPIPE
, SIG_IGN
);
1528 # elif defined(HAVE_SIGACTION)
1529 struct sigaction action
; /* POSIX sigaction data */
1532 memset(&action
, 0, sizeof(action
));
1533 action
.sa_handler
= SIG_IGN
;
1534 sigaction(SIGPIPE
, &action
, NULL
);
1537 signal(SIGPIPE
, SIG_IGN
);
1538 # endif /* !SO_NOSIGPIPE */
1543 * Initialize GNU TLS...
1546 gnutls_global_init();
1548 #elif defined(HAVE_LIBSSL)
1550 * Initialize OpenSSL...
1553 SSL_load_error_strings();
1557 * Using the current time is a dubious random seed, but on some systems
1558 * it is the best we can do (on others, this seed isn't even used...)
1561 CUPS_SRAND(time(NULL
));
1563 for (i
= 0; i
< sizeof(data
); i
++)
1564 data
[i
] = CUPS_RAND();
1566 RAND_seed(data
, sizeof(data
));
1567 #endif /* HAVE_GNUTLS */
1570 _cupsGlobalUnlock();
1575 * 'httpOptions()' - Send an OPTIONS request to the server.
1578 int /* O - Status of call (0 = success) */
1579 httpOptions(http_t
*http
, /* I - Connection to server */
1580 const char *uri
) /* I - URI for options */
1582 return (http_send(http
, HTTP_OPTIONS
, uri
));
1587 * '_httpPeek()' - Peek at data from a HTTP connection.
1589 * This function copies available data from the given HTTP connection, reading
1590 * a buffer as needed. The data is still available for reading using
1591 * @link httpRead@ or @link httpRead2@.
1593 * For non-blocking connections the usual timeouts apply.
1596 ssize_t
/* O - Number of bytes copied */
1597 _httpPeek(http_t
*http
, /* I - Connection to server */
1598 char *buffer
, /* I - Buffer for data */
1599 size_t length
) /* I - Maximum number of bytes */
1601 ssize_t bytes
; /* Bytes read */
1602 char len
[32]; /* Length string */
1605 DEBUG_printf(("_httpPeek(http=%p, buffer=%p, length=" CUPS_LLFMT
")",
1606 http
, buffer
, CUPS_LLCAST length
));
1608 if (http
== NULL
|| buffer
== NULL
)
1611 http
->activity
= time(NULL
);
1617 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
&&
1618 http
->data_remaining
<= 0)
1620 DEBUG_puts("2_httpPeek: Getting chunk length...");
1622 if (httpGets(len
, sizeof(len
), http
) == NULL
)
1624 DEBUG_puts("1_httpPeek: Could not get length!");
1628 http
->data_remaining
= strtoll(len
, NULL
, 16);
1629 if (http
->data_remaining
< 0)
1631 DEBUG_puts("1_httpPeek: Negative chunk length!");
1636 DEBUG_printf(("2_httpPeek: data_remaining=" CUPS_LLFMT
,
1637 CUPS_LLCAST http
->data_remaining
));
1639 if (http
->data_remaining
<= 0)
1642 * A zero-length chunk ends a transfer; unless we are reading POST
1646 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
1647 httpGets(len
, sizeof(len
), http
);
1649 if (http
->state
== HTTP_POST_RECV
)
1652 http
->state
= HTTP_WAITING
;
1655 * Prevent future reads for this request...
1658 http
->data_encoding
= HTTP_ENCODE_LENGTH
;
1662 else if (length
> (size_t)http
->data_remaining
)
1663 length
= (size_t)http
->data_remaining
;
1665 if (http
->used
== 0)
1668 * Buffer small reads for better performance...
1671 if (!http
->blocking
)
1673 while (!httpWait(http
, http
->wait_value
))
1675 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
1682 if (http
->data_remaining
> sizeof(http
->buffer
))
1683 bytes
= sizeof(http
->buffer
);
1685 bytes
= http
->data_remaining
;
1689 bytes
= http_read_ssl(http
, http
->buffer
, bytes
);
1691 #endif /* HAVE_SSL */
1693 DEBUG_printf(("2_httpPeek: reading %d bytes from socket into buffer...",
1696 bytes
= recv(http
->fd
, http
->buffer
, bytes
, 0);
1698 DEBUG_printf(("2_httpPeek: read %d bytes from socket into buffer...",
1707 if (WSAGetLastError() != WSAEINTR
&& WSAGetLastError() != WSAEWOULDBLOCK
)
1709 http
->error
= WSAGetLastError();
1713 if (errno
!= EINTR
&& errno
!= EAGAIN
)
1715 http
->error
= errno
;
1722 http
->error
= EPIPE
;
1729 if (length
> (size_t)http
->used
)
1730 length
= (size_t)http
->used
;
1732 bytes
= (ssize_t
)length
;
1734 DEBUG_printf(("2_httpPeek: grabbing %d bytes from input buffer...",
1737 memcpy(buffer
, http
->buffer
, length
);
1745 if (WSAGetLastError() == WSAEINTR
|| WSAGetLastError() == WSAEWOULDBLOCK
)
1748 http
->error
= WSAGetLastError();
1750 if (errno
== EINTR
|| errno
== EAGAIN
)
1753 http
->error
= errno
;
1756 else if (bytes
== 0)
1758 http
->error
= EPIPE
;
1763 http_debug_hex("_httpPeek", buffer
, (int)bytes
);
1771 * 'httpPost()' - Send a POST request to the server.
1774 int /* O - Status of call (0 = success) */
1775 httpPost(http_t
*http
, /* I - Connection to server */
1776 const char *uri
) /* I - URI for post */
1778 return (http_send(http
, HTTP_POST
, uri
));
1783 * 'httpPrintf()' - Print a formatted string to a HTTP connection.
1788 int /* O - Number of bytes written */
1789 httpPrintf(http_t
*http
, /* I - Connection to server */
1790 const char *format
, /* I - printf-style format string */
1791 ...) /* I - Additional args as needed */
1793 int bytes
; /* Number of bytes to write */
1794 char buf
[16384]; /* Buffer for formatted string */
1795 va_list ap
; /* Variable argument pointer */
1798 DEBUG_printf(("2httpPrintf(http=%p, format=\"%s\", ...)", http
, format
));
1800 va_start(ap
, format
);
1801 bytes
= vsnprintf(buf
, sizeof(buf
), format
, ap
);
1804 DEBUG_printf(("3httpPrintf: %s", buf
));
1806 if (http
->data_encoding
== HTTP_ENCODE_FIELDS
)
1807 return (httpWrite2(http
, buf
, bytes
));
1812 DEBUG_puts("4httpPrintf: flushing existing data...");
1814 if (httpFlushWrite(http
) < 0)
1818 return (http_write(http
, buf
, bytes
));
1824 * 'httpPut()' - Send a PUT request to the server.
1827 int /* O - Status of call (0 = success) */
1828 httpPut(http_t
*http
, /* I - Connection to server */
1829 const char *uri
) /* I - URI to put */
1831 DEBUG_printf(("httpPut(http=%p, uri=\"%s\")", http
, uri
));
1832 return (http_send(http
, HTTP_PUT
, uri
));
1837 * 'httpRead()' - Read data from a HTTP connection.
1839 * This function is deprecated. Use the httpRead2() function which can
1840 * read more than 2GB of data.
1845 int /* O - Number of bytes read */
1846 httpRead(http_t
*http
, /* I - Connection to server */
1847 char *buffer
, /* I - Buffer for data */
1848 int length
) /* I - Maximum number of bytes */
1850 return ((int)httpRead2(http
, buffer
, length
));
1855 * 'httpRead2()' - Read data from a HTTP connection.
1857 * @since CUPS 1.2/Mac OS X 10.5@
1860 ssize_t
/* O - Number of bytes read */
1861 httpRead2(http_t
*http
, /* I - Connection to server */
1862 char *buffer
, /* I - Buffer for data */
1863 size_t length
) /* I - Maximum number of bytes */
1865 ssize_t bytes
; /* Bytes read */
1866 char len
[32]; /* Length string */
1869 DEBUG_printf(("httpRead2(http=%p, buffer=%p, length=" CUPS_LLFMT
")",
1870 http
, buffer
, CUPS_LLCAST length
));
1872 if (http
== NULL
|| buffer
== NULL
)
1875 http
->activity
= time(NULL
);
1881 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
&&
1882 http
->data_remaining
<= 0)
1884 DEBUG_puts("2httpRead2: Getting chunk length...");
1886 if (httpGets(len
, sizeof(len
), http
) == NULL
)
1888 DEBUG_puts("1httpRead2: Could not get length!");
1892 http
->data_remaining
= strtoll(len
, NULL
, 16);
1893 if (http
->data_remaining
< 0)
1895 DEBUG_puts("1httpRead2: Negative chunk length!");
1900 DEBUG_printf(("2httpRead2: data_remaining=" CUPS_LLFMT
,
1901 CUPS_LLCAST http
->data_remaining
));
1903 if (http
->data_remaining
<= 0)
1906 * A zero-length chunk ends a transfer; unless we are reading POST
1910 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
1911 httpGets(len
, sizeof(len
), http
);
1913 if (http
->state
== HTTP_POST_RECV
)
1916 http
->state
= HTTP_WAITING
;
1919 * Prevent future reads for this request...
1922 http
->data_encoding
= HTTP_ENCODE_LENGTH
;
1926 else if (length
> (size_t)http
->data_remaining
)
1927 length
= (size_t)http
->data_remaining
;
1929 if (http
->used
== 0 && length
<= 256)
1932 * Buffer small reads for better performance...
1935 ssize_t buflen
; /* Length of read for buffer */
1937 if (!http
->blocking
)
1939 while (!httpWait(http
, http
->wait_value
))
1941 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
1948 if (http
->data_remaining
> sizeof(http
->buffer
))
1949 buflen
= sizeof(http
->buffer
);
1951 buflen
= http
->data_remaining
;
1953 DEBUG_printf(("2httpRead2: Reading %d bytes into buffer.", (int)buflen
));
1959 bytes
= http_read_ssl(http
, http
->buffer
, buflen
);
1961 #endif /* HAVE_SSL */
1962 bytes
= recv(http
->fd
, http
->buffer
, buflen
, 0);
1967 if (WSAGetLastError() != WSAEINTR
)
1969 http
->error
= WSAGetLastError();
1972 else if (WSAGetLastError() == WSAEWOULDBLOCK
)
1974 if (!http
->timeout_cb
||
1975 !(*http
->timeout_cb
)(http
, http
->timeout_data
))
1977 http
->error
= WSAEWOULDBLOCK
;
1982 if (errno
== EWOULDBLOCK
|| errno
== EAGAIN
)
1984 if (http
->timeout_cb
&& !(*http
->timeout_cb
)(http
, http
->timeout_data
))
1986 http
->error
= errno
;
1989 else if (!http
->timeout_cb
&& errno
!= EAGAIN
)
1991 http
->error
= errno
;
1995 else if (errno
!= EINTR
)
1997 http
->error
= errno
;
2005 DEBUG_printf(("2httpRead2: Read " CUPS_LLFMT
" bytes into buffer.",
2006 CUPS_LLCAST bytes
));
2008 http_debug_hex("httpRead2", http
->buffer
, (int)bytes
);
2016 if (length
> (size_t)http
->used
)
2017 length
= (size_t)http
->used
;
2019 bytes
= (ssize_t
)length
;
2021 DEBUG_printf(("2httpRead2: grabbing %d bytes from input buffer...",
2024 memcpy(buffer
, http
->buffer
, length
);
2025 http
->used
-= (int)length
;
2028 memmove(http
->buffer
, http
->buffer
+ length
, http
->used
);
2033 if (!http
->blocking
)
2035 while (!httpWait(http
, http
->wait_value
))
2037 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
2044 while ((bytes
= (ssize_t
)http_read_ssl(http
, buffer
, (int)length
)) < 0)
2047 if (WSAGetLastError() == WSAEWOULDBLOCK
)
2049 if (!http
->timeout_cb
|| !(*http
->timeout_cb
)(http
, http
->timeout_data
))
2052 else if (WSAGetLastError() != WSAEINTR
)
2055 if (errno
== EWOULDBLOCK
|| errno
== EAGAIN
)
2057 if (http
->timeout_cb
&& !(*http
->timeout_cb
)(http
, http
->timeout_data
))
2059 else if (!http
->timeout_cb
&& errno
!= EAGAIN
)
2062 else if (errno
!= EINTR
)
2067 #endif /* HAVE_SSL */
2070 if (!http
->blocking
)
2072 while (!httpWait(http
, http
->wait_value
))
2074 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
2081 DEBUG_printf(("2httpRead2: reading " CUPS_LLFMT
" bytes from socket...",
2082 CUPS_LLCAST length
));
2085 while ((bytes
= (ssize_t
)recv(http
->fd
, buffer
, (int)length
, 0)) < 0)
2087 if (WSAGetLastError() == WSAEWOULDBLOCK
)
2089 if (!http
->timeout_cb
|| !(*http
->timeout_cb
)(http
, http
->timeout_data
))
2092 else if (WSAGetLastError() != WSAEINTR
)
2096 while ((bytes
= recv(http
->fd
, buffer
, length
, 0)) < 0)
2098 if (errno
== EWOULDBLOCK
|| errno
== EAGAIN
)
2100 if (http
->timeout_cb
&& !(*http
->timeout_cb
)(http
, http
->timeout_data
))
2102 else if (!http
->timeout_cb
&& errno
!= EAGAIN
)
2105 else if (errno
!= EINTR
)
2110 DEBUG_printf(("2httpRead2: read " CUPS_LLFMT
" bytes from socket...",
2111 CUPS_LLCAST bytes
));
2113 http_debug_hex("httpRead2", buffer
, (int)bytes
);
2119 http
->data_remaining
-= bytes
;
2121 if (http
->data_remaining
<= INT_MAX
)
2122 http
->_data_remaining
= (int)http
->data_remaining
;
2124 http
->_data_remaining
= INT_MAX
;
2129 if (WSAGetLastError() == WSAEINTR
)
2132 http
->error
= WSAGetLastError();
2134 if (errno
== EINTR
|| (errno
== EAGAIN
&& !http
->timeout_cb
))
2137 http
->error
= errno
;
2142 http
->error
= EPIPE
;
2146 if (http
->data_remaining
== 0)
2148 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
2149 httpGets(len
, sizeof(len
), http
);
2151 if (http
->data_encoding
!= HTTP_ENCODE_CHUNKED
)
2153 if (http
->state
== HTTP_POST_RECV
)
2156 http
->state
= HTTP_WAITING
;
2164 #if defined(HAVE_SSL) && defined(HAVE_CDSASSL)
2166 * '_httpReadCDSA()' - Read function for the CDSA library.
2169 OSStatus
/* O - -1 on error, 0 on success */
2171 SSLConnectionRef connection
, /* I - SSL/TLS connection */
2172 void *data
, /* I - Data buffer */
2173 size_t *dataLength
) /* IO - Number of bytes */
2175 OSStatus result
; /* Return value */
2176 ssize_t bytes
; /* Number of bytes read */
2177 http_t
*http
; /* HTTP connection */
2180 http
= (http_t
*)connection
;
2182 if (!http
->blocking
)
2185 * Make sure we have data before we read...
2188 while (!_httpWait(http
, http
->wait_value
, 0))
2190 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
2193 http
->error
= ETIMEDOUT
;
2200 bytes
= recv(http
->fd
, data
, *dataLength
, 0);
2202 while (bytes
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
2204 if (bytes
== *dataLength
)
2210 *dataLength
= bytes
;
2211 result
= errSSLWouldBlock
;
2218 result
= errSSLClosedGraceful
;
2219 else if (errno
== EAGAIN
)
2220 result
= errSSLWouldBlock
;
2222 result
= errSSLClosedAbort
;
2227 #endif /* HAVE_SSL && HAVE_CDSASSL */
2230 #if defined(HAVE_SSL) && defined(HAVE_GNUTLS)
2232 * '_httpReadGNUTLS()' - Read function for the GNU TLS library.
2235 ssize_t
/* O - Number of bytes read or -1 on error */
2237 gnutls_transport_ptr ptr
, /* I - Connection to server */
2238 void *data
, /* I - Buffer */
2239 size_t length
) /* I - Number of bytes to read */
2241 http_t
*http
; /* HTTP connection */
2242 ssize_t bytes
; /* Bytes read */
2245 DEBUG_printf(("6_httpReadGNUTLS(ptr=%p, data=%p, length=%d)", ptr
, data
, (int)length
));
2247 http
= (http_t
*)ptr
;
2249 if (!http
->blocking
)
2252 * Make sure we have data before we read...
2255 while (!_httpWait(http
, http
->wait_value
, 0))
2257 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
2260 http
->error
= ETIMEDOUT
;
2265 bytes
= recv(http
->fd
, data
, length
, 0);
2266 DEBUG_printf(("6_httpReadGNUTLS: bytes=%d", (int)bytes
));
2269 #endif /* HAVE_SSL && HAVE_GNUTLS */
2273 * 'httpReconnect()' - Reconnect to a HTTP server.
2276 int /* O - 0 on success, non-zero on failure */
2277 httpReconnect(http_t
*http
) /* I - Connection to server */
2279 DEBUG_printf(("httpReconnect(http=%p)", http
));
2281 return (httpReconnect2(http
, 30000, NULL
));
2286 * 'httpReconnect2()' - Reconnect to a HTTP server with timeout and optional
2290 int /* O - 0 on success, non-zero on failure */
2291 httpReconnect2(http_t
*http
, /* I - Connection to server */
2292 int msec
, /* I - Timeout in milliseconds */
2293 int *cancel
) /* I - Pointer to "cancel" variable */
2295 http_addrlist_t
*addr
; /* Connected address */
2297 http_addrlist_t
*current
; /* Current address */
2298 char temp
[256]; /* Temporary address string */
2302 DEBUG_printf(("httpReconnect2(http=%p, msec=%d, cancel=%p)", http
, msec
,
2307 _cupsSetError(IPP_INTERNAL_ERROR
, strerror(EINVAL
), 0);
2314 DEBUG_puts("2httpReconnect2: Shutting down SSL/TLS...");
2315 http_shutdown_ssl(http
);
2317 #endif /* HAVE_SSL */
2320 * Close any previously open socket...
2325 DEBUG_printf(("2httpReconnect2: Closing socket %d...", http
->fd
));
2328 closesocket(http
->fd
);
2337 * Connect to the server...
2341 for (current
= http
->addrlist
; current
; current
= current
->next
)
2342 DEBUG_printf(("2httpReconnect2: Address %s:%d",
2343 httpAddrString(&(current
->addr
), temp
, sizeof(temp
)),
2344 _httpAddrPort(&(current
->addr
))));
2347 if ((addr
= httpAddrConnect2(http
->addrlist
, &(http
->fd
), msec
,
2351 * Unable to connect...
2355 http
->error
= WSAGetLastError();
2357 http
->error
= errno
;
2359 http
->status
= HTTP_ERROR
;
2361 DEBUG_printf(("1httpReconnect2: httpAddrConnect failed: %s",
2362 strerror(http
->error
)));
2367 DEBUG_printf(("2httpReconnect2: New socket=%d", http
->fd
));
2369 if (http
->timeout_value
> 0)
2370 http_set_timeout(http
->fd
, http
->timeout_value
);
2372 http
->hostaddr
= &(addr
->addr
);
2374 http
->status
= HTTP_CONTINUE
;
2375 http
->state
= HTTP_WAITING
;
2378 if (http
->encryption
== HTTP_ENCRYPT_ALWAYS
)
2381 * Always do encryption via SSL.
2384 if (http_setup_ssl(http
) != 0)
2387 closesocket(http
->fd
);
2395 else if (http
->encryption
== HTTP_ENCRYPT_REQUIRED
)
2396 return (http_upgrade(http
));
2397 #endif /* HAVE_SSL */
2399 DEBUG_printf(("1httpReconnect2: Connected to %s:%d...",
2400 httpAddrString(http
->hostaddr
, temp
, sizeof(temp
)),
2401 _httpAddrPort(http
->hostaddr
)));
2408 * 'httpSetAuthString()' - Set the current authorization string.
2410 * This function just stores a copy of the current authorization string in
2411 * the HTTP connection object. You must still call httpSetField() to set
2412 * HTTP_FIELD_AUTHORIZATION prior to issuing a HTTP request using httpGet(),
2413 * httpHead(), httpOptions(), httpPost, or httpPut().
2415 * @since CUPS 1.3/Mac OS X 10.5@
2419 httpSetAuthString(http_t
*http
, /* I - Connection to server */
2420 const char *scheme
, /* I - Auth scheme (NULL to clear it) */
2421 const char *data
) /* I - Auth data (NULL for none) */
2424 * Range check input...
2430 if (http
->authstring
&& http
->authstring
!= http
->_authstring
)
2431 free(http
->authstring
);
2433 http
->authstring
= http
->_authstring
;
2438 * Set the current authorization string...
2441 int len
= (int)strlen(scheme
) + (data
? (int)strlen(data
) + 1 : 0) + 1;
2444 if (len
> (int)sizeof(http
->_authstring
))
2446 if ((temp
= malloc(len
)) == NULL
)
2447 len
= sizeof(http
->_authstring
);
2449 http
->authstring
= temp
;
2453 snprintf(http
->authstring
, len
, "%s %s", scheme
, data
);
2455 strlcpy(http
->authstring
, scheme
, len
);
2460 * Clear the current authorization string...
2463 http
->_authstring
[0] = '\0';
2469 * 'httpSetCredentials()' - Set the credentials associated with an encrypted
2472 * @since CUPS 1.5/Mac OS X 10.7@
2475 int /* O - Status of call (0 = success) */
2476 httpSetCredentials(http_t
*http
, /* I - Connection to server */
2477 cups_array_t
*credentials
) /* I - Array of credentials */
2479 if (!http
|| cupsArrayCount(credentials
) < 1)
2482 _httpFreeCredentials(http
->tls_credentials
);
2484 http
->tls_credentials
= _httpCreateCredentials(credentials
);
2486 return (http
->tls_credentials
? 0 : -1);
2491 * 'httpSetCookie()' - Set the cookie value(s).
2493 * @since CUPS 1.1.19/Mac OS X 10.3@
2497 httpSetCookie(http_t
*http
, /* I - Connection */
2498 const char *cookie
) /* I - Cookie string */
2507 http
->cookie
= strdup(cookie
);
2509 http
->cookie
= NULL
;
2514 * 'httpSetExpect()' - Set the Expect: header in a request.
2516 * Currently only HTTP_CONTINUE is supported for the "expect" argument.
2518 * @since CUPS 1.2/Mac OS X 10.5@
2522 httpSetExpect(http_t
*http
, /* I - Connection to server */
2523 http_status_t expect
) /* I - HTTP status to expect (HTTP_CONTINUE) */
2526 http
->expect
= expect
;
2531 * 'httpSetField()' - Set the value of an HTTP header.
2535 httpSetField(http_t
*http
, /* I - Connection to server */
2536 http_field_t field
, /* I - Field index */
2537 const char *value
) /* I - Value */
2540 field
< HTTP_FIELD_ACCEPT_LANGUAGE
||
2541 field
> HTTP_FIELD_WWW_AUTHENTICATE
||
2545 strlcpy(http
->fields
[field
], value
, HTTP_MAX_VALUE
);
2547 if (field
== HTTP_FIELD_AUTHORIZATION
)
2550 * Special case for Authorization: as its contents can be
2551 * longer than HTTP_MAX_VALUE
2554 if (http
->field_authorization
)
2555 free(http
->field_authorization
);
2557 http
->field_authorization
= strdup(value
);
2559 else if (field
== HTTP_FIELD_HOST
)
2562 * Special-case for Host: as we don't want a trailing "." on the hostname and
2563 * need to bracket IPv6 numeric addresses.
2566 char *ptr
= strchr(value
, ':');
2568 if (value
[0] != '[' && ptr
&& strchr(ptr
+ 1, ':'))
2571 * Bracket IPv6 numeric addresses...
2573 * This is slightly inefficient (basically copying twice), but is an edge
2574 * case and not worth optimizing...
2577 snprintf(http
->fields
[HTTP_FIELD_HOST
],
2578 sizeof(http
->fields
[HTTP_FIELD_HOST
]), "[%s]", value
);
2583 * Check for a trailing dot on the hostname...
2586 ptr
= http
->fields
[HTTP_FIELD_HOST
];
2590 ptr
+= strlen(ptr
) - 1;
2601 * 'httpSetLength()' - Set the content-length and content-encoding.
2603 * @since CUPS 1.2/Mac OS X 10.5@
2607 httpSetLength(http_t
*http
, /* I - Connection to server */
2608 size_t length
) /* I - Length (0 for chunked) */
2615 strcpy(http
->fields
[HTTP_FIELD_TRANSFER_ENCODING
], "chunked");
2616 http
->fields
[HTTP_FIELD_CONTENT_LENGTH
][0] = '\0';
2620 http
->fields
[HTTP_FIELD_TRANSFER_ENCODING
][0] = '\0';
2621 snprintf(http
->fields
[HTTP_FIELD_CONTENT_LENGTH
], HTTP_MAX_VALUE
,
2622 CUPS_LLFMT
, CUPS_LLCAST length
);
2628 * 'httpSetTimeout()' - Set read/write timeouts and an optional callback.
2630 * The optional timeout callback receives both the HTTP connection and a user
2631 * data pointer and must return 1 to continue or 0 to error (time) out.
2633 * @since CUPS 1.5/Mac OS X 10.7@
2638 http_t
*http
, /* I - Connection to server */
2639 double timeout
, /* I - Number of seconds for timeout,
2640 must be greater than 0 */
2641 http_timeout_cb_t cb
, /* I - Callback function or NULL */
2642 void *user_data
) /* I - User data pointer */
2644 if (!http
|| timeout
<= 0.0)
2647 http
->timeout_cb
= cb
;
2648 http
->timeout_data
= user_data
;
2649 http
->timeout_value
= timeout
;
2652 http_set_timeout(http
->fd
, timeout
);
2654 http_set_wait(http
);
2659 * 'httpTrace()' - Send an TRACE request to the server.
2662 int /* O - Status of call (0 = success) */
2663 httpTrace(http_t
*http
, /* I - Connection to server */
2664 const char *uri
) /* I - URI for trace */
2666 return (http_send(http
, HTTP_TRACE
, uri
));
2671 * '_httpUpdate()' - Update the current HTTP status for incoming data.
2673 * Note: Unlike httpUpdate(), this function does not flush pending write data
2674 * and only retrieves a single status line from the HTTP connection.
2677 int /* O - 1 to continue, 0 to stop */
2678 _httpUpdate(http_t
*http
, /* I - Connection to server */
2679 http_status_t
*status
) /* O - Current HTTP status */
2681 char line
[32768], /* Line from connection... */
2682 *value
; /* Pointer to value on line */
2683 http_field_t field
; /* Field index */
2684 int major
, minor
; /* HTTP version numbers */
2687 DEBUG_printf(("_httpUpdate(http=%p, status=%p), state=%s", http
, status
,
2688 http_states
[http
->state
]));
2691 * Grab a single line from the connection...
2694 if (!httpGets(line
, sizeof(line
), http
))
2696 *status
= HTTP_ERROR
;
2700 DEBUG_printf(("2_httpUpdate: Got \"%s\"", line
));
2702 if (line
[0] == '\0')
2705 * Blank line means the start of the data section (if any). Return
2706 * the result code, too...
2708 * If we get status 100 (HTTP_CONTINUE), then we *don't* change states.
2709 * Instead, we just return HTTP_CONTINUE to the caller and keep on
2713 if (http
->status
== HTTP_CONTINUE
)
2715 *status
= http
->status
;
2719 if (http
->status
< HTTP_BAD_REQUEST
)
2720 http
->digest_tries
= 0;
2723 if (http
->status
== HTTP_SWITCHING_PROTOCOLS
&& !http
->tls
)
2725 if (http_setup_ssl(http
) != 0)
2728 closesocket(http
->fd
);
2733 *status
= http
->status
= HTTP_ERROR
;
2737 *status
= HTTP_CONTINUE
;
2740 #endif /* HAVE_SSL */
2742 httpGetLength2(http
);
2744 switch (http
->state
)
2748 case HTTP_POST_RECV
:
2751 case HTTP_POST_SEND
:
2756 http
->state
= HTTP_WAITING
;
2760 *status
= http
->status
;
2763 else if (!strncmp(line
, "HTTP/", 5))
2766 * Got the beginning of a response...
2769 int intstatus
; /* Status value as an integer */
2771 if (sscanf(line
, "HTTP/%d.%d%d", &major
, &minor
, &intstatus
) != 3)
2773 *status
= http
->status
= HTTP_ERROR
;
2777 http
->version
= (http_version_t
)(major
* 100 + minor
);
2778 *status
= http
->status
= (http_status_t
)intstatus
;
2780 else if ((value
= strchr(line
, ':')) != NULL
)
2787 while (_cups_isspace(*value
))
2791 * Be tolerants of servers that send unknown attribute fields...
2794 if (!_cups_strcasecmp(line
, "expect"))
2797 * "Expect: 100-continue" or similar...
2800 http
->expect
= (http_status_t
)atoi(value
);
2802 else if (!_cups_strcasecmp(line
, "cookie"))
2805 * "Cookie: name=value[; name=value ...]" - replaces previous cookies...
2808 httpSetCookie(http
, value
);
2810 else if ((field
= http_field(line
)) != HTTP_FIELD_UNKNOWN
)
2811 httpSetField(http
, field
, value
);
2814 DEBUG_printf(("1_httpUpdate: unknown field %s seen!", line
));
2819 DEBUG_printf(("1_httpUpdate: Bad response line \"%s\"!", line
));
2820 *status
= http
->status
= HTTP_ERROR
;
2829 * 'httpUpdate()' - Update the current HTTP state for incoming data.
2832 http_status_t
/* O - HTTP status */
2833 httpUpdate(http_t
*http
) /* I - Connection to server */
2835 http_status_t status
; /* Request status */
2838 DEBUG_printf(("httpUpdate(http=%p), state=%s", http
,
2839 http_states
[http
->state
]));
2842 * Flush pending data, if any...
2847 DEBUG_puts("2httpUpdate: flushing buffer...");
2849 if (httpFlushWrite(http
) < 0)
2850 return (HTTP_ERROR
);
2854 * If we haven't issued any commands, then there is nothing to "update"...
2857 if (http
->state
== HTTP_WAITING
)
2858 return (HTTP_CONTINUE
);
2861 * Grab all of the lines we can from the connection...
2864 while (_httpUpdate(http
, &status
));
2867 * See if there was an error...
2870 if (http
->error
== EPIPE
&& http
->status
> HTTP_CONTINUE
)
2872 DEBUG_printf(("1httpUpdate: Returning status %d...", http
->status
));
2873 return (http
->status
);
2878 DEBUG_printf(("1httpUpdate: socket error %d - %s", http
->error
,
2879 strerror(http
->error
)));
2880 http
->status
= HTTP_ERROR
;
2881 return (HTTP_ERROR
);
2885 * Return the current status...
2893 * '_httpWait()' - Wait for data available on a connection (no flush).
2896 int /* O - 1 if data is available, 0 otherwise */
2897 _httpWait(http_t
*http
, /* I - Connection to server */
2898 int msec
, /* I - Milliseconds to wait */
2899 int usessl
) /* I - Use SSL context? */
2902 struct pollfd pfd
; /* Polled file descriptor */
2904 fd_set input_set
; /* select() input set */
2905 struct timeval timeout
; /* Timeout */
2906 #endif /* HAVE_POLL */
2907 int nfds
; /* Result from select()/poll() */
2910 DEBUG_printf(("4_httpWait(http=%p, msec=%d, usessl=%d)", http
, msec
, usessl
));
2914 DEBUG_printf(("5_httpWait: Returning 0 since fd=%d", http
->fd
));
2919 * Check the SSL/TLS buffers for data first...
2923 if (http
->tls
&& usessl
)
2926 if (SSL_pending(http
->tls
))
2928 DEBUG_puts("5_httpWait: Return 1 since there is pending SSL data.");
2932 # elif defined(HAVE_GNUTLS)
2933 if (gnutls_record_check_pending(http
->tls
))
2935 DEBUG_puts("5_httpWait: Return 1 since there is pending SSL data.");
2939 # elif defined(HAVE_CDSASSL)
2940 size_t bytes
; /* Bytes that are available */
2942 if (!SSLGetBufferedReadSize(http
->tls
, &bytes
) &&
2945 DEBUG_puts("5_httpWait: Return 1 since there is pending SSL data.");
2948 # endif /* HAVE_LIBSSL */
2950 #endif /* HAVE_SSL */
2953 * Then try doing a select() or poll() to poll the socket...
2958 pfd
.events
= POLLIN
;
2960 while ((nfds
= poll(&pfd
, 1, msec
)) < 0 &&
2961 (errno
== EINTR
|| errno
== EAGAIN
));
2966 FD_ZERO(&input_set
);
2967 FD_SET(http
->fd
, &input_set
);
2969 DEBUG_printf(("6_httpWait: msec=%d, http->fd=%d", msec
, http
->fd
));
2973 timeout
.tv_sec
= msec
/ 1000;
2974 timeout
.tv_usec
= (msec
% 1000) * 1000;
2976 nfds
= select(http
->fd
+ 1, &input_set
, NULL
, NULL
, &timeout
);
2979 nfds
= select(http
->fd
+ 1, &input_set
, NULL
, NULL
, NULL
);
2981 DEBUG_printf(("6_httpWait: select() returned %d...", nfds
));
2984 while (nfds
< 0 && (WSAGetLastError() == WSAEINTR
||
2985 WSAGetLastError() == WSAEWOULDBLOCK
));
2987 while (nfds
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
2989 #endif /* HAVE_POLL */
2991 DEBUG_printf(("5_httpWait: returning with nfds=%d, errno=%d...", nfds
,
2999 * 'httpWait()' - Wait for data available on a connection.
3001 * @since CUPS 1.1.19/Mac OS X 10.3@
3004 int /* O - 1 if data is available, 0 otherwise */
3005 httpWait(http_t
*http
, /* I - Connection to server */
3006 int msec
) /* I - Milliseconds to wait */
3009 * First see if there is data in the buffer...
3012 DEBUG_printf(("2httpWait(http=%p, msec=%d)", http
, msec
));
3019 DEBUG_puts("3httpWait: Returning 1 since there is buffered data ready.");
3024 * Flush pending data, if any...
3029 DEBUG_puts("3httpWait: Flushing write buffer.");
3031 if (httpFlushWrite(http
) < 0)
3036 * If not, check the SSL/TLS buffers and do a select() on the connection...
3039 return (_httpWait(http
, msec
, 1));
3044 * 'httpWrite()' - Write data to a HTTP connection.
3046 * This function is deprecated. Use the httpWrite2() function which can
3047 * write more than 2GB of data.
3052 int /* O - Number of bytes written */
3053 httpWrite(http_t
*http
, /* I - Connection to server */
3054 const char *buffer
, /* I - Buffer for data */
3055 int length
) /* I - Number of bytes to write */
3057 return ((int)httpWrite2(http
, buffer
, length
));
3062 * 'httpWrite2()' - Write data to a HTTP connection.
3064 * @since CUPS 1.2/Mac OS X 10.5@
3067 ssize_t
/* O - Number of bytes written */
3068 httpWrite2(http_t
*http
, /* I - Connection to server */
3069 const char *buffer
, /* I - Buffer for data */
3070 size_t length
) /* I - Number of bytes to write */
3072 ssize_t bytes
; /* Bytes written */
3075 DEBUG_printf(("httpWrite2(http=%p, buffer=%p, length=" CUPS_LLFMT
")", http
,
3076 buffer
, CUPS_LLCAST length
));
3079 * Range check input...
3082 if (http
== NULL
|| buffer
== NULL
)
3086 * Mark activity on the connection...
3089 http
->activity
= time(NULL
);
3092 * Buffer small writes for better performance...
3097 if (http
->wused
&& (length
+ http
->wused
) > sizeof(http
->wbuffer
))
3099 DEBUG_printf(("2httpWrite2: Flushing buffer (wused=%d, length="
3100 CUPS_LLFMT
")", http
->wused
, CUPS_LLCAST length
));
3102 httpFlushWrite(http
);
3105 if ((length
+ http
->wused
) <= sizeof(http
->wbuffer
) &&
3106 length
< sizeof(http
->wbuffer
))
3109 * Write to buffer...
3112 DEBUG_printf(("2httpWrite2: Copying " CUPS_LLFMT
" bytes to wbuffer...",
3113 CUPS_LLCAST length
));
3115 memcpy(http
->wbuffer
+ http
->wused
, buffer
, length
);
3116 http
->wused
+= (int)length
;
3117 bytes
= (ssize_t
)length
;
3122 * Otherwise write the data directly...
3125 DEBUG_printf(("2httpWrite2: Writing " CUPS_LLFMT
" bytes to socket...",
3126 CUPS_LLCAST length
));
3128 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
3129 bytes
= (ssize_t
)http_write_chunk(http
, buffer
, (int)length
);
3131 bytes
= (ssize_t
)http_write(http
, buffer
, (int)length
);
3133 DEBUG_printf(("2httpWrite2: Wrote " CUPS_LLFMT
" bytes...",
3134 CUPS_LLCAST bytes
));
3137 if (http
->data_encoding
== HTTP_ENCODE_LENGTH
)
3138 http
->data_remaining
-= bytes
;
3144 * Handle end-of-request processing...
3147 if ((http
->data_encoding
== HTTP_ENCODE_CHUNKED
&& length
== 0) ||
3148 (http
->data_encoding
== HTTP_ENCODE_LENGTH
&& http
->data_remaining
== 0))
3151 * Finished with the transfer; unless we are sending POST or PUT
3155 DEBUG_puts("2httpWrite: changing states...");
3158 httpFlushWrite(http
);
3160 if (http
->data_encoding
== HTTP_ENCODE_CHUNKED
)
3163 * Send a 0-length chunk at the end of the request...
3166 http_write(http
, "0\r\n\r\n", 5);
3169 * Reset the data state...
3172 http
->data_encoding
= HTTP_ENCODE_LENGTH
;
3173 http
->data_remaining
= 0;
3181 #if defined(HAVE_SSL) && defined(HAVE_CDSASSL)
3183 * '_httpWriteCDSA()' - Write function for the CDSA library.
3186 OSStatus
/* O - -1 on error, 0 on success */
3188 SSLConnectionRef connection
, /* I - SSL/TLS connection */
3189 const void *data
, /* I - Data buffer */
3190 size_t *dataLength
) /* IO - Number of bytes */
3192 OSStatus result
; /* Return value */
3193 ssize_t bytes
; /* Number of bytes read */
3194 http_t
*http
; /* HTTP connection */
3197 http
= (http_t
*)connection
;
3201 bytes
= write(http
->fd
, data
, *dataLength
);
3203 while (bytes
== -1 && (errno
== EINTR
|| errno
== EAGAIN
));
3205 if (bytes
== *dataLength
)
3209 else if (bytes
>= 0)
3211 *dataLength
= bytes
;
3212 result
= errSSLWouldBlock
;
3218 if (errno
== EAGAIN
)
3219 result
= errSSLWouldBlock
;
3221 result
= errSSLClosedAbort
;
3226 #endif /* HAVE_SSL && HAVE_CDSASSL */
3229 #if defined(HAVE_SSL) && defined(HAVE_GNUTLS)
3231 * '_httpWriteGNUTLS()' - Write function for the GNU TLS library.
3234 ssize_t
/* O - Number of bytes written or -1 on error */
3236 gnutls_transport_ptr ptr
, /* I - Connection to server */
3237 const void *data
, /* I - Data buffer */
3238 size_t length
) /* I - Number of bytes to write */
3240 ssize_t bytes
; /* Bytes written */
3243 DEBUG_printf(("6_httpWriteGNUTLS(ptr=%p, data=%p, length=%d)", ptr
, data
,
3246 http_debug_hex("_httpWriteGNUTLS", data
, (int)length
);
3249 bytes
= send(((http_t
*)ptr
)->fd
, data
, length
, 0);
3250 DEBUG_printf(("_httpWriteGNUTLS: bytes=%d", (int)bytes
));
3254 #endif /* HAVE_SSL && HAVE_GNUTLS */
3257 #if defined(HAVE_SSL) && defined(HAVE_LIBSSL)
3259 * 'http_bio_ctrl()' - Control the HTTP connection.
3262 static long /* O - Result/data */
3263 http_bio_ctrl(BIO
*h
, /* I - BIO data */
3264 int cmd
, /* I - Control command */
3265 long arg1
, /* I - First argument */
3266 void *arg2
) /* I - Second argument */
3273 case BIO_CTRL_RESET
:
3277 case BIO_C_SET_FILE_PTR
:
3282 case BIO_C_GET_FILE_PTR
:
3285 *((void **)arg2
) = h
->ptr
;
3292 case BIO_CTRL_FLUSH
:
3299 * 'http_bio_free()' - Free OpenSSL data.
3302 static int /* O - 1 on success, 0 on failure */
3303 http_bio_free(BIO
*h
) /* I - BIO data */
3319 * 'http_bio_new()' - Initialize an OpenSSL BIO structure.
3322 static int /* O - 1 on success, 0 on failure */
3323 http_bio_new(BIO
*h
) /* I - BIO data */
3338 * 'http_bio_puts()' - Send a string for OpenSSL.
3341 static int /* O - Bytes written */
3342 http_bio_puts(BIO
*h
, /* I - BIO data */
3343 const char *str
) /* I - String to write */
3346 return (send(((http_t
*)h
->ptr
)->fd
, str
, (int)strlen(str
), 0));
3348 return (send(((http_t
*)h
->ptr
)->fd
, str
, strlen(str
), 0));
3354 * 'http_bio_read()' - Read data for OpenSSL.
3357 static int /* O - Bytes read */
3358 http_bio_read(BIO
*h
, /* I - BIO data */
3359 char *buf
, /* I - Buffer */
3360 int size
) /* I - Number of bytes to read */
3362 http_t
*http
; /* HTTP connection */
3365 http
= (http_t
*)h
->ptr
;
3367 if (!http
->blocking
)
3370 * Make sure we have data before we read...
3373 while (!_httpWait(http
, http
->wait_value
, 0))
3375 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
3379 http
->error
= WSAETIMEDOUT
;
3381 http
->error
= ETIMEDOUT
;
3388 return (recv(http
->fd
, buf
, size
, 0));
3393 * 'http_bio_write()' - Write data for OpenSSL.
3396 static int /* O - Bytes written */
3397 http_bio_write(BIO
*h
, /* I - BIO data */
3398 const char *buf
, /* I - Buffer to write */
3399 int num
) /* I - Number of bytes to write */
3401 return (send(((http_t
*)h
->ptr
)->fd
, buf
, num
, 0));
3403 #endif /* HAVE_SSL && HAVE_LIBSSL */
3408 * 'http_debug_hex()' - Do a hex dump of a buffer.
3412 http_debug_hex(const char *prefix
, /* I - Prefix for line */
3413 const char *buffer
, /* I - Buffer to dump */
3414 int bytes
) /* I - Bytes to dump */
3416 int i
, j
, /* Looping vars */
3417 ch
; /* Current character */
3418 char line
[255], /* Line buffer */
3419 *start
, /* Start of line after prefix */
3420 *ptr
; /* Pointer into line */
3423 if (_cups_debug_fd
< 0 || _cups_debug_level
< 6)
3426 DEBUG_printf(("6%s: %d bytes:", prefix
, bytes
));
3428 snprintf(line
, sizeof(line
), "6%s: ", prefix
);
3429 start
= line
+ strlen(line
);
3431 for (i
= 0; i
< bytes
; i
+= 16)
3433 for (j
= 0, ptr
= start
; j
< 16 && (i
+ j
) < bytes
; j
++, ptr
+= 2)
3434 sprintf(ptr
, "%02X", buffer
[i
+ j
] & 255);
3446 for (j
= 0; j
< 16 && (i
+ j
) < bytes
; j
++)
3448 ch
= buffer
[i
+ j
] & 255;
3450 if (ch
< ' ' || ch
>= 127)
3464 * 'http_field()' - Return the field index for a field name.
3467 static http_field_t
/* O - Field index */
3468 http_field(const char *name
) /* I - String name */
3470 int i
; /* Looping var */
3473 for (i
= 0; i
< HTTP_FIELD_MAX
; i
++)
3474 if (_cups_strcasecmp(name
, http_fields
[i
]) == 0)
3475 return ((http_field_t
)i
);
3477 return (HTTP_FIELD_UNKNOWN
);
3483 * 'http_read_ssl()' - Read from a SSL/TLS connection.
3486 static int /* O - Bytes read */
3487 http_read_ssl(http_t
*http
, /* I - Connection to server */
3488 char *buf
, /* I - Buffer to store data */
3489 int len
) /* I - Length of buffer */
3491 # if defined(HAVE_LIBSSL)
3492 return (SSL_read((SSL
*)(http
->tls
), buf
, len
));
3494 # elif defined(HAVE_GNUTLS)
3495 ssize_t result
; /* Return value */
3498 result
= gnutls_record_recv(http
->tls
, buf
, len
);
3500 if (result
< 0 && !errno
)
3503 * Convert GNU TLS error to errno value...
3508 case GNUTLS_E_INTERRUPTED
:
3512 case GNUTLS_E_AGAIN
:
3524 return ((int)result
);
3526 # elif defined(HAVE_CDSASSL)
3527 int result
; /* Return value */
3528 OSStatus error
; /* Error info */
3529 size_t processed
; /* Number of bytes processed */
3532 error
= SSLRead(http
->tls
, buf
, len
, &processed
);
3533 DEBUG_printf(("6http_read_ssl: error=%d, processed=%d", (int)error
,
3538 result
= (int)processed
;
3541 case errSSLWouldBlock
:
3543 result
= (int)processed
;
3551 case errSSLClosedGraceful
:
3554 result
= (int)processed
;
3565 # elif defined(HAVE_SSPISSL)
3566 return _sspiRead((_sspi_struct_t
*) http
->tls
, buf
, len
);
3567 # endif /* HAVE_LIBSSL */
3569 #endif /* HAVE_SSL */
3573 * 'http_send()' - Send a request with all fields and the trailing blank line.
3576 static int /* O - 0 on success, non-zero on error */
3577 http_send(http_t
*http
, /* I - Connection to server */
3578 http_state_t request
, /* I - Request code */
3579 const char *uri
) /* I - URI */
3581 int i
; /* Looping var */
3582 char buf
[1024]; /* Encoded URI buffer */
3583 static const char * const codes
[] =
3584 { /* Request code strings */
3601 DEBUG_printf(("7http_send(http=%p, request=HTTP_%s, uri=\"%s\")",
3602 http
, codes
[request
], uri
));
3604 if (http
== NULL
|| uri
== NULL
)
3608 * Set the User-Agent field if it isn't already...
3611 if (!http
->fields
[HTTP_FIELD_USER_AGENT
][0])
3612 httpSetField(http
, HTTP_FIELD_USER_AGENT
, CUPS_MINIMAL
);
3615 * Encode the URI as needed...
3618 _httpEncodeURI(buf
, uri
, sizeof(buf
));
3621 * See if we had an error the last time around; if so, reconnect...
3624 if (http
->status
== HTTP_ERROR
|| http
->status
>= HTTP_BAD_REQUEST
)
3625 if (httpReconnect(http
))
3629 * Flush any written data that is pending...
3634 if (httpFlushWrite(http
) < 0)
3635 if (httpReconnect(http
))
3640 * Send the request header...
3643 http
->state
= request
;
3644 http
->data_encoding
= HTTP_ENCODE_FIELDS
;
3646 if (request
== HTTP_POST
|| request
== HTTP_PUT
)
3649 http
->status
= HTTP_CONTINUE
;
3652 if (http
->encryption
== HTTP_ENCRYPT_REQUIRED
&& !http
->tls
)
3654 httpSetField(http
, HTTP_FIELD_CONNECTION
, "Upgrade");
3655 httpSetField(http
, HTTP_FIELD_UPGRADE
, "TLS/1.0,SSL/2.0,SSL/3.0");
3657 #endif /* HAVE_SSL */
3659 if (httpPrintf(http
, "%s %s HTTP/1.1\r\n", codes
[request
], buf
) < 1)
3661 http
->status
= HTTP_ERROR
;
3665 for (i
= 0; i
< HTTP_FIELD_MAX
; i
++)
3666 if (http
->fields
[i
][0] != '\0')
3668 DEBUG_printf(("9http_send: %s: %s", http_fields
[i
],
3669 httpGetField(http
, i
)));
3671 if (httpPrintf(http
, "%s: %s\r\n", http_fields
[i
],
3672 httpGetField(http
, i
)) < 1)
3674 http
->status
= HTTP_ERROR
;
3680 if (httpPrintf(http
, "Cookie: $Version=0; %s\r\n", http
->cookie
) < 1)
3682 http
->status
= HTTP_ERROR
;
3686 if (http
->expect
== HTTP_CONTINUE
&&
3687 (http
->state
== HTTP_POST_RECV
|| http
->state
== HTTP_PUT_RECV
))
3688 if (httpPrintf(http
, "Expect: 100-continue\r\n") < 1)
3690 http
->status
= HTTP_ERROR
;
3694 if (httpPrintf(http
, "\r\n") < 1)
3696 http
->status
= HTTP_ERROR
;
3700 if (httpFlushWrite(http
) < 0)
3703 httpGetLength2(http
);
3704 httpClearFields(http
);
3707 * The Kerberos and AuthRef authentication strings can only be used once...
3710 if (http
->field_authorization
&& http
->authstring
&&
3711 (!strncmp(http
->authstring
, "Negotiate", 9) ||
3712 !strncmp(http
->authstring
, "AuthRef", 7)))
3714 http
->_authstring
[0] = '\0';
3716 if (http
->authstring
!= http
->_authstring
)
3717 free(http
->authstring
);
3719 http
->authstring
= http
->_authstring
;
3727 # if defined(HAVE_CDSASSL) && defined(HAVE_SECCERTIFICATECOPYDATA)
3729 * 'http_set_credentials()' - Set the SSL/TLS credentials.
3732 static int /* O - Status of connection */
3733 http_set_credentials(http_t
*http
) /* I - Connection to server */
3735 _cups_globals_t
*cg
= _cupsGlobals(); /* Pointer to library globals */
3736 OSStatus error
= 0; /* Error code */
3737 http_tls_credentials_t credentials
= NULL
;
3738 /* TLS credentials */
3741 DEBUG_printf(("7http_set_credentials(%p)", http
));
3744 * Prefer connection specific credentials...
3747 if ((credentials
= http
->tls_credentials
) == NULL
)
3748 credentials
= cg
->tls_credentials
;
3750 # if HAVE_SECPOLICYCREATESSL
3752 * Otherwise root around in the user's keychain to see if one can be found...
3757 CFDictionaryRef query
; /* Query dictionary */
3758 CFTypeRef matches
= NULL
; /* Matching credentials */
3759 CFArrayRef dn_array
= NULL
;/* Distinguished names array */
3760 CFTypeRef keys
[] = { kSecClass
,
3763 /* Keys for dictionary */
3764 CFTypeRef values
[] = { kSecClassCertificate
,
3767 /* Values for dictionary */
3770 * Get the names associated with the server.
3773 if ((error
= SSLCopyDistinguishedNames(http
->tls
, &dn_array
)) != noErr
)
3775 DEBUG_printf(("4http_set_credentials: SSLCopyDistinguishedNames, error=%d",
3781 * Create a query which will return all identities that can sign and match
3782 * the passed in policy.
3785 query
= CFDictionaryCreate(NULL
,
3786 (const void**)(&keys
[0]),
3787 (const void**)(&values
[0]),
3788 sizeof(keys
) / sizeof(keys
[0]),
3789 &kCFTypeDictionaryKeyCallBacks
,
3790 &kCFTypeDictionaryValueCallBacks
);
3793 error
= SecItemCopyMatching(query
, &matches
);
3794 DEBUG_printf(("4http_set_credentials: SecItemCopyMatching, error=%d",
3803 CFRelease(dn_array
);
3805 # endif /* HAVE_SECPOLICYCREATESSL */
3809 error
= SSLSetCertificate(http
->tls
, credentials
);
3810 DEBUG_printf(("4http_set_credentials: SSLSetCertificate, error=%d",
3814 DEBUG_puts("4http_set_credentials: No credentials to set.");
3818 # endif /* HAVE_CDSASSL && HAVE_SECCERTIFICATECOPYDATA */
3819 #endif /* HAVE_SSL */
3823 * 'http_set_timeout()' - Set the socket timeout values.
3827 http_set_timeout(int fd
, /* I - File descriptor */
3828 double timeout
) /* I - Timeout in seconds */
3831 DWORD tv
= (DWORD
)(timeout
* 1000);
3832 /* Timeout in milliseconds */
3834 setsockopt(fd
, SOL_SOCKET
, SO_RCVTIMEO
, (char *)&tv
, sizeof(tv
));
3835 setsockopt(fd
, SOL_SOCKET
, SO_SNDTIMEO
, (char *)&tv
, sizeof(tv
));
3838 struct timeval tv
; /* Timeout in secs and usecs */
3840 tv
.tv_sec
= (int)timeout
;
3841 tv
.tv_usec
= (int)(1000000 * fmod(timeout
, 1.0));
3843 setsockopt(fd
, SOL_SOCKET
, SO_RCVTIMEO
, &tv
, sizeof(tv
));
3844 setsockopt(fd
, SOL_SOCKET
, SO_SNDTIMEO
, &tv
, sizeof(tv
));
3850 * 'http_set_wait()' - Set the default wait value for reads.
3854 http_set_wait(http_t
*http
) /* I - Connection to server */
3858 http
->wait_value
= (int)(http
->timeout_value
* 1000);
3860 if (http
->wait_value
<= 0)
3861 http
->wait_value
= 60000;
3864 http
->wait_value
= 10000;
3870 * 'http_setup_ssl()' - Set up SSL/TLS support on a connection.
3873 static int /* O - 0 on success, -1 on failure */
3874 http_setup_ssl(http_t
*http
) /* I - Connection to server */
3876 _cups_globals_t
*cg
= _cupsGlobals();
3877 /* Pointer to library globals */
3878 int any_root
; /* Allow any root */
3879 char hostname
[256], /* Hostname */
3880 *hostptr
; /* Pointer into hostname */
3883 SSL_CTX
*context
; /* Context for encryption */
3884 BIO
*bio
; /* BIO data */
3885 const char *message
= NULL
;/* Error message */
3886 # elif defined(HAVE_GNUTLS)
3887 int status
; /* Status of handshake */
3888 gnutls_certificate_client_credentials
*credentials
;
3889 /* TLS credentials */
3890 # elif defined(HAVE_CDSASSL)
3891 OSStatus error
; /* Error code */
3892 const char *message
= NULL
;/* Error message */
3893 # ifdef HAVE_SECCERTIFICATECOPYDATA
3894 cups_array_t
*credentials
; /* Credentials array */
3895 cups_array_t
*names
; /* CUPS distinguished names */
3896 CFArrayRef dn_array
; /* CF distinguished names array */
3897 CFIndex count
; /* Number of credentials */
3898 CFDataRef data
; /* Certificate data */
3899 int i
; /* Looping var */
3900 http_credential_t
*credential
; /* Credential data */
3901 # endif /* HAVE_SECCERTIFICATECOPYDATA */
3902 # elif defined(HAVE_SSPISSL)
3903 TCHAR username
[256]; /* Username returned from GetUserName() */
3904 TCHAR commonName
[256];/* Common name for certificate */
3905 DWORD dwSize
; /* 32 bit size */
3906 # endif /* HAVE_LIBSSL */
3909 DEBUG_printf(("7http_setup_ssl(http=%p)", http
));
3912 * Always allow self-signed certificates for the local loopback address...
3915 if (httpAddrLocalhost(http
->hostaddr
))
3918 strlcpy(hostname
, "localhost", sizeof(hostname
));
3923 * Otherwise use the system-wide setting and make sure the hostname we have
3924 * does not end in a trailing dot.
3927 any_root
= cg
->any_root
;
3929 strlcpy(hostname
, http
->hostname
, sizeof(hostname
));
3930 if ((hostptr
= hostname
+ strlen(hostname
) - 1) >= hostname
&&
3938 context
= SSL_CTX_new(SSLv23_client_method());
3940 SSL_CTX_set_options(context
, SSL_OP_NO_SSLv2
); /* Only use SSLv3 or TLS */
3942 bio
= BIO_new(_httpBIOMethods());
3943 BIO_ctrl(bio
, BIO_C_SET_FILE_PTR
, 0, (char *)http
);
3945 http
->tls
= SSL_new(context
);
3946 SSL_set_bio(http
->tls
, bio
, bio
);
3948 SSL_set_tlsext_host_name(http
->tls
, hostname
);
3950 if (SSL_connect(http
->tls
) != 1)
3952 unsigned long error
; /* Error code */
3954 while ((error
= ERR_get_error()) != 0)
3956 message
= ERR_error_string(error
, NULL
);
3957 DEBUG_printf(("8http_setup_ssl: %s", message
));
3960 SSL_CTX_free(context
);
3961 SSL_free(http
->tls
);
3965 http
->error
= WSAGetLastError();
3967 http
->error
= errno
;
3969 http
->status
= HTTP_ERROR
;
3972 message
= _("Unable to establish a secure connection to host.");
3974 _cupsSetError(IPP_PKI_ERROR
, message
, 1);
3979 # elif defined(HAVE_GNUTLS)
3982 credentials
= (gnutls_certificate_client_credentials
*)
3983 malloc(sizeof(gnutls_certificate_client_credentials
));
3984 if (credentials
== NULL
)
3986 DEBUG_printf(("8http_setup_ssl: Unable to allocate credentials: %s",
3988 http
->error
= errno
;
3989 http
->status
= HTTP_ERROR
;
3990 _cupsSetHTTPError(HTTP_ERROR
);
3995 gnutls_certificate_allocate_credentials(credentials
);
3997 gnutls_init(&http
->tls
, GNUTLS_CLIENT
);
3998 gnutls_set_default_priority(http
->tls
);
3999 gnutls_server_name_set(http
->tls
, GNUTLS_NAME_DNS
, hostname
,
4001 gnutls_credentials_set(http
->tls
, GNUTLS_CRD_CERTIFICATE
, *credentials
);
4002 gnutls_transport_set_ptr(http
->tls
, (gnutls_transport_ptr
)http
);
4003 gnutls_transport_set_pull_function(http
->tls
, _httpReadGNUTLS
);
4004 gnutls_transport_set_push_function(http
->tls
, _httpWriteGNUTLS
);
4006 while ((status
= gnutls_handshake(http
->tls
)) != GNUTLS_E_SUCCESS
)
4008 DEBUG_printf(("8http_setup_ssl: gnutls_handshake returned %d (%s)",
4009 status
, gnutls_strerror(status
)));
4011 if (gnutls_error_is_fatal(status
))
4014 http
->status
= HTTP_ERROR
;
4016 _cupsSetError(IPP_PKI_ERROR
, gnutls_strerror(status
), 0);
4018 gnutls_deinit(http
->tls
);
4019 gnutls_certificate_free_credentials(*credentials
);
4027 http
->tls_credentials
= credentials
;
4029 # elif defined(HAVE_CDSASSL)
4030 if ((error
= SSLNewContext(false, &http
->tls
)))
4032 http
->error
= errno
;
4033 http
->status
= HTTP_ERROR
;
4034 _cupsSetHTTPError(HTTP_ERROR
);
4039 error
= SSLSetConnection(http
->tls
, http
);
4040 DEBUG_printf(("4http_setup_ssl: SSLSetConnection, error=%d", (int)error
));
4044 error
= SSLSetIOFuncs(http
->tls
, _httpReadCDSA
, _httpWriteCDSA
);
4045 DEBUG_printf(("4http_setup_ssl: SSLSetIOFuncs, error=%d", (int)error
));
4050 error
= SSLSetAllowsAnyRoot(http
->tls
, any_root
);
4051 DEBUG_printf(("4http_setup_ssl: SSLSetAllowsAnyRoot(%d), error=%d",
4052 any_root
, (int)error
));
4057 error
= SSLSetAllowsExpiredCerts(http
->tls
, cg
->expired_certs
);
4058 DEBUG_printf(("4http_setup_ssl: SSLSetAllowsExpiredCerts(%d), error=%d",
4059 cg
->expired_certs
, (int)error
));
4064 error
= SSLSetAllowsExpiredRoots(http
->tls
, cg
->expired_root
);
4065 DEBUG_printf(("4http_setup_ssl: SSLSetAllowsExpiredRoots(%d), error=%d",
4066 cg
->expired_root
, (int)error
));
4070 * In general, don't verify certificates since things like the common name
4071 * often do not match...
4076 error
= SSLSetEnableCertVerify(http
->tls
, false);
4077 DEBUG_printf(("4http_setup_ssl: SSLSetEnableCertVerify, error=%d",
4081 # ifdef HAVE_SECCERTIFICATECOPYDATA
4084 if (cg
->client_cert_cb
)
4086 error
= SSLSetSessionOption(http
->tls
,
4087 kSSLSessionOptionBreakOnCertRequested
, true);
4088 DEBUG_printf(("4http_setup_ssl: kSSLSessionOptionBreakOnCertRequested, "
4089 "error=%d", (int)error
));
4093 error
= http_set_credentials(http
);
4094 DEBUG_printf(("4http_setup_ssl: http_set_credentials, error=%d",
4100 * If there's a server certificate callback installed let it evaluate the
4101 * certificate(s) during the handshake...
4104 if (!error
&& cg
->server_cert_cb
!= NULL
)
4106 error
= SSLSetSessionOption(http
->tls
,
4107 kSSLSessionOptionBreakOnServerAuth
, true);
4108 DEBUG_printf(("4http_setup_ssl: kSSLSessionOptionBreakOnServerAuth, "
4109 "error=%d", (int)error
));
4111 # endif /* HAVE_SECCERTIFICATECOPYDATA */
4114 * Let the server know which hostname/domain we are trying to connect to
4115 * in case it wants to serve up a certificate with a matching common name.
4120 error
= SSLSetPeerDomainName(http
->tls
, hostname
, strlen(hostname
));
4122 DEBUG_printf(("4http_setup_ssl: SSLSetPeerDomainName, error=%d",
4128 int done
= 0; /* Are we done yet? */
4130 while (!error
&& !done
)
4132 error
= SSLHandshake(http
->tls
);
4134 DEBUG_printf(("4http_setup_ssl: SSLHandshake returned %d.", (int)error
));
4142 case errSSLWouldBlock
:
4146 # ifdef HAVE_SECCERTIFICATECOPYDATA
4147 case errSSLServerAuthCompleted
:
4149 if (cg
->server_cert_cb
)
4151 error
= httpCopyCredentials(http
, &credentials
);
4154 error
= (cg
->server_cert_cb
)(http
, http
->tls
, credentials
,
4155 cg
->server_cert_data
);
4156 httpFreeCredentials(credentials
);
4159 DEBUG_printf(("4http_setup_ssl: Server certificate callback "
4160 "returned %d.", (int)error
));
4164 case errSSLClientCertRequested
:
4167 if (cg
->client_cert_cb
)
4170 if (!(error
= SSLCopyDistinguishedNames(http
->tls
, &dn_array
)) &&
4173 if ((names
= cupsArrayNew(NULL
, NULL
)) != NULL
)
4175 for (i
= 0, count
= CFArrayGetCount(dn_array
); i
< count
; i
++)
4177 data
= (CFDataRef
)CFArrayGetValueAtIndex(dn_array
, i
);
4179 if ((credential
= malloc(sizeof(*credential
))))
4181 credential
->datalen
= CFDataGetLength(data
);
4182 if ((credential
->data
= malloc(credential
->datalen
)))
4184 memcpy((void *)credential
->data
, CFDataGetBytePtr(data
),
4185 credential
->datalen
);
4186 cupsArrayAdd(names
, credential
);
4192 CFRelease(dn_array
);
4197 error
= (cg
->client_cert_cb
)(http
, http
->tls
, names
,
4198 cg
->client_cert_data
);
4200 DEBUG_printf(("4http_setup_ssl: Client certificate callback "
4201 "returned %d.", (int)error
));
4204 httpFreeCredentials(names
);
4207 # endif /* HAVE_SECCERTIFICATECOPYDATA */
4209 case errSSLUnknownRootCert
:
4210 message
= _("Unable to establish a secure connection to host "
4211 "(untrusted certificate).");
4214 case errSSLNoRootCert
:
4215 message
= _("Unable to establish a secure connection to host "
4216 "(self-signed certificate).");
4219 case errSSLCertExpired
:
4220 message
= _("Unable to establish a secure connection to host "
4221 "(expired certificate).");
4224 case errSSLCertNotYetValid
:
4225 message
= _("Unable to establish a secure connection to host "
4226 "(certificate not yet valid).");
4229 case errSSLHostNameMismatch
:
4230 message
= _("Unable to establish a secure connection to host "
4231 "(host name mismatch).");
4234 case errSSLXCertChainInvalid
:
4235 message
= _("Unable to establish a secure connection to host "
4236 "(certificate chain invalid).");
4239 case errSSLConnectionRefused
:
4240 message
= _("Unable to establish a secure connection to host "
4241 "(peer dropped connection before responding).");
4252 http
->error
= error
;
4253 http
->status
= HTTP_ERROR
;
4254 errno
= ECONNREFUSED
;
4256 SSLDisposeContext(http
->tls
);
4260 * If an error string wasn't set by the callbacks use a generic one...
4264 #ifdef HAVE_CSSMERRORSTRING
4265 message
= cssmErrorString(error
);
4267 message
= _("Unable to establish a secure connection to host.");
4268 #endif /* HAVE_CSSMERRORSTRING */
4270 _cupsSetError(IPP_PKI_ERROR
, message
, 1);
4275 # elif defined(HAVE_SSPISSL)
4276 http
->tls
= _sspiAlloc();
4280 _cupsSetHTTPError(HTTP_ERROR
);
4284 http
->tls
->sock
= http
->fd
;
4285 dwSize
= sizeof(username
) / sizeof(TCHAR
);
4286 GetUserName(username
, &dwSize
);
4287 _sntprintf_s(commonName
, sizeof(commonName
) / sizeof(TCHAR
),
4288 sizeof(commonName
) / sizeof(TCHAR
), TEXT("CN=%s"), username
);
4290 if (!_sspiGetCredentials(http
->tls_credentials
, L
"ClientContainer",
4293 _sspiFree(http
->tls_credentials
);
4294 http
->tls_credentials
= NULL
;
4297 http
->status
= HTTP_ERROR
;
4299 _cupsSetError(IPP_PKI_ERROR
,
4300 _("Unable to establish a secure connection to host."), 1);
4305 _sspiSetAllowsAnyRoot(http
->tls_credentials
, any_root
);
4306 _sspiSetAllowsExpiredCerts(http
->tls_credentials
, TRUE
);
4308 if (!_sspiConnect(http
->tls_credentials
, hostname
))
4310 _sspiFree(http
->tls_credentials
);
4311 http
->tls_credentials
= NULL
;
4314 http
->status
= HTTP_ERROR
;
4316 _cupsSetError(IPP_PKI_ERROR
,
4317 _("Unable to establish a secure connection to host."), 1);
4321 # endif /* HAVE_CDSASSL */
4328 * 'http_shutdown_ssl()' - Shut down SSL/TLS on a connection.
4332 http_shutdown_ssl(http_t
*http
) /* I - Connection to server */
4335 SSL_CTX
*context
; /* Context for encryption */
4337 context
= SSL_get_SSL_CTX(http
->tls
);
4339 SSL_shutdown(http
->tls
);
4340 SSL_CTX_free(context
);
4341 SSL_free(http
->tls
);
4343 # elif defined(HAVE_GNUTLS)
4344 gnutls_certificate_client_credentials
*credentials
;
4345 /* TLS credentials */
4347 credentials
= (gnutls_certificate_client_credentials
*)(http
->tls_credentials
);
4349 gnutls_bye(http
->tls
, GNUTLS_SHUT_RDWR
);
4350 gnutls_deinit(http
->tls
);
4351 gnutls_certificate_free_credentials(*credentials
);
4354 # elif defined(HAVE_CDSASSL)
4355 while (SSLClose(http
->tls
) == errSSLWouldBlock
)
4358 SSLDisposeContext(http
->tls
);
4360 if (http
->tls_credentials
)
4361 CFRelease(http
->tls_credentials
);
4363 # elif defined(HAVE_SSPISSL)
4364 _sspiFree(http
->tls_credentials
);
4365 # endif /* HAVE_LIBSSL */
4368 http
->tls_credentials
= NULL
;
4370 #endif /* HAVE_SSL */
4375 * 'http_upgrade()' - Force upgrade to TLS encryption.
4378 static int /* O - Status of connection */
4379 http_upgrade(http_t
*http
) /* I - Connection to server */
4381 int ret
; /* Return value */
4382 http_t myhttp
; /* Local copy of HTTP data */
4385 DEBUG_printf(("7http_upgrade(%p)", http
));
4388 * Flush the connection to make sure any previous "Upgrade" message
4395 * Copy the HTTP data to a local variable so we can do the OPTIONS
4396 * request without interfering with the existing request data...
4399 memcpy(&myhttp
, http
, sizeof(myhttp
));
4402 * Send an OPTIONS request to the server, requiring SSL or TLS
4403 * encryption on the link...
4406 http
->field_authorization
= NULL
; /* Don't free the auth string */
4408 httpClearFields(http
);
4409 httpSetField(http
, HTTP_FIELD_CONNECTION
, "upgrade");
4410 httpSetField(http
, HTTP_FIELD_UPGRADE
, "TLS/1.2, TLS/1.1, TLS/1.0, SSL/3.0");
4412 if ((ret
= httpOptions(http
, "*")) == 0)
4415 * Wait for the secure connection...
4418 while (httpUpdate(http
) == HTTP_CONTINUE
);
4422 * Restore the HTTP request data...
4425 memcpy(http
->fields
, myhttp
.fields
, sizeof(http
->fields
));
4426 http
->data_encoding
= myhttp
.data_encoding
;
4427 http
->data_remaining
= myhttp
.data_remaining
;
4428 http
->_data_remaining
= myhttp
._data_remaining
;
4429 http
->expect
= myhttp
.expect
;
4430 http
->field_authorization
= myhttp
.field_authorization
;
4431 http
->digest_tries
= myhttp
.digest_tries
;
4434 * See if we actually went secure...
4440 * Server does not support HTTP upgrade...
4443 DEBUG_puts("8http_upgrade: Server does not support HTTP upgrade!");
4446 closesocket(http
->fd
);
4458 #endif /* HAVE_SSL */
4462 * 'http_write()' - Write a buffer to a HTTP connection.
4465 static int /* O - Number of bytes written */
4466 http_write(http_t
*http
, /* I - Connection to server */
4467 const char *buffer
, /* I - Buffer for data */
4468 int length
) /* I - Number of bytes to write */
4470 int tbytes
, /* Total bytes sent */
4471 bytes
; /* Bytes sent */
4474 DEBUG_printf(("2http_write(http=%p, buffer=%p, length=%d)", http
, buffer
,
4481 DEBUG_printf(("3http_write: About to write %d bytes.", (int)length
));
4483 if (http
->timeout_cb
)
4486 struct pollfd pfd
; /* Polled file descriptor */
4488 fd_set output_set
; /* Output ready for write? */
4489 struct timeval timeout
; /* Timeout value */
4490 #endif /* HAVE_POLL */
4491 int nfds
; /* Result from select()/poll() */
4497 pfd
.events
= POLLOUT
;
4499 while ((nfds
= poll(&pfd
, 1, http
->wait_value
)) < 0 &&
4500 (errno
== EINTR
|| errno
== EAGAIN
));
4505 FD_ZERO(&output_set
);
4506 FD_SET(http
->fd
, &output_set
);
4508 timeout
.tv_sec
= http
->wait_value
/ 1000;
4509 timeout
.tv_usec
= 1000 * (http
->wait_value
% 1000);
4511 nfds
= select(http
->fd
+ 1, NULL
, &output_set
, NULL
, &timeout
);
4514 while (nfds
< 0 && (WSAGetLastError() == WSAEINTR
||
4515 WSAGetLastError() == WSAEWOULDBLOCK
));
4517 while (nfds
< 0 && (errno
== EINTR
|| errno
== EAGAIN
));
4519 #endif /* HAVE_POLL */
4523 http
->error
= errno
;
4526 else if (nfds
== 0 && !(*http
->timeout_cb
)(http
, http
->timeout_data
))
4529 http
->error
= WSAEWOULDBLOCK
;
4531 http
->error
= EWOULDBLOCK
;
4541 bytes
= http_write_ssl(http
, buffer
, length
);
4543 #endif /* HAVE_SSL */
4544 bytes
= send(http
->fd
, buffer
, length
, 0);
4546 DEBUG_printf(("3http_write: Write of %d bytes returned %d.", (int)length
,
4552 if (WSAGetLastError() == WSAEINTR
)
4554 else if (WSAGetLastError() == WSAEWOULDBLOCK
)
4556 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
4559 http
->error
= WSAGetLastError();
4561 else if (WSAGetLastError() != http
->error
&&
4562 WSAGetLastError() != WSAECONNRESET
)
4564 http
->error
= WSAGetLastError();
4571 else if (errno
== EWOULDBLOCK
|| errno
== EAGAIN
)
4573 if (http
->timeout_cb
&& (*http
->timeout_cb
)(http
, http
->timeout_data
))
4575 else if (!http
->timeout_cb
&& errno
== EAGAIN
)
4578 http
->error
= errno
;
4580 else if (errno
!= http
->error
&& errno
!= ECONNRESET
)
4582 http
->error
= errno
;
4587 DEBUG_printf(("3http_write: error writing data (%s).",
4588 strerror(http
->error
)));
4599 http_debug_hex("http_write", buffer
- tbytes
, tbytes
);
4602 DEBUG_printf(("3http_write: Returning %d.", tbytes
));
4609 * 'http_write_chunk()' - Write a chunked buffer.
4612 static int /* O - Number bytes written */
4613 http_write_chunk(http_t
*http
, /* I - Connection to server */
4614 const char *buffer
, /* I - Buffer to write */
4615 int length
) /* I - Length of buffer */
4617 char header
[255]; /* Chunk header */
4618 int bytes
; /* Bytes written */
4621 DEBUG_printf(("7http_write_chunk(http=%p, buffer=%p, length=%d)",
4622 http
, buffer
, length
));
4625 * Write the chunk header, data, and trailer.
4628 sprintf(header
, "%x\r\n", length
);
4629 if (http_write(http
, header
, (int)strlen(header
)) < 0)
4631 DEBUG_puts("8http_write_chunk: http_write of length failed!");
4635 if ((bytes
= http_write(http
, buffer
, length
)) < 0)
4637 DEBUG_puts("8http_write_chunk: http_write of buffer failed!");
4641 if (http_write(http
, "\r\n", 2) < 0)
4643 DEBUG_puts("8http_write_chunk: http_write of CR LF failed!");
4653 * 'http_write_ssl()' - Write to a SSL/TLS connection.
4656 static int /* O - Bytes written */
4657 http_write_ssl(http_t
*http
, /* I - Connection to server */
4658 const char *buf
, /* I - Buffer holding data */
4659 int len
) /* I - Length of buffer */
4661 ssize_t result
; /* Return value */
4664 DEBUG_printf(("2http_write_ssl(http=%p, buf=%p, len=%d)", http
, buf
, len
));
4666 # if defined(HAVE_LIBSSL)
4667 result
= SSL_write((SSL
*)(http
->tls
), buf
, len
);
4669 # elif defined(HAVE_GNUTLS)
4670 result
= gnutls_record_send(http
->tls
, buf
, len
);
4672 if (result
< 0 && !errno
)
4675 * Convert GNU TLS error to errno value...
4680 case GNUTLS_E_INTERRUPTED
:
4684 case GNUTLS_E_AGAIN
:
4696 # elif defined(HAVE_CDSASSL)
4697 OSStatus error
; /* Error info */
4698 size_t processed
; /* Number of bytes processed */
4701 error
= SSLWrite(http
->tls
, buf
, len
, &processed
);
4706 result
= (int)processed
;
4709 case errSSLWouldBlock
:
4711 result
= (int)processed
;
4719 case errSSLClosedGraceful
:
4722 result
= (int)processed
;
4730 # elif defined(HAVE_SSPISSL)
4731 return _sspiWrite((_sspi_struct_t
*)http
->tls
, (void *)buf
, len
);
4732 # endif /* HAVE_LIBSSL */
4734 DEBUG_printf(("3http_write_ssl: Returning %d.", (int)result
));
4736 return ((int)result
);
4738 #endif /* HAVE_SSL */
4742 * End of "$Id: http.c 7850 2008-08-20 00:07:25Z mike $".