Add httpGetCookieValue API.

Author: michaelrsweet

CHANGES.md

@@ -5,7 +5,7 @@ libcups v3.0.0 (YYYY-MM-DD)
 ---------------------------
 
 - Added `cupsOAuthGetJWKS` API.
-- Added `httpGetSecurity` API.
+- Added `httpGetCookieValue` and `httpGetSecurity` APIs.
 - Updated `ippfind` to use `cupsGetClock` API.
 - Fixed return values of `ippDateToTime` when the timezone isn't GMT.
 - Fixed a potential timing issue with `cupsEnumDests`.

cups/http.c

@@ -840,7 +840,11 @@ httpGetContentEncoding(http_t *http)	// I - HTTP connection
 
 
 //
-// 'httpGetCookie()' - Get any cookie data from the response.
+// 'httpGetCookie()' - Get "Cookie:" data from the HTTP connection.
+//
+// This function returns any HTTP "Cookie:" header data for the given HTTP
+// connection as described in RFC 6265.  Use the @link httpGetCookieValue@ to
+// get the value of a named cookie.
 //
 
 const char *				// O - Cookie data or `NULL`
@@ -850,6 +854,105 @@ httpGetCookie(http_t *http)		// I - HTTP connection
 }
 
 
+//
+// 'httpGetCookieValue()' - Get the value of a named cookie from the HTTP connection.
+//
+// This function copies the value of a named cookie in the HTTP "Cookie:" header
+// for the given HTTP connection as described in RFC 6265.  Use the
+// @link httpGetCookie@ function to get the original "Cookie:" string.
+//
+
+char *					// O - Cookie value or `NULL` if not present
+httpGetCookieValue(http_t     *http,	// I - HTTP connection
+                   const char *name,	// I - Cookie name
+                   char       *buffer,	// I - Value buffer
+                   size_t     bufsize)	// I - Size of value buffer
+{
+  const char	*cookie;		// Cookie: header value
+  char		current[128],		// Current name string
+		*ptr,			// Pointer into name/buffer
+		*end;			// End of name/buffer
+  bool		match;			// Does the current name match?
+
+
+  // Range check input...
+  if (buffer)
+    *buffer = '\0';
+
+  if (!http || !http->cookie || !name || !buffer || bufsize < 2)
+    return (NULL);
+
+  // Loop through the cookie string...
+  for (cookie = http->cookie; *cookie;)
+  {
+    // Skip leading whitespace...
+    while (isspace(*cookie & 255))
+      cookie ++;
+    if (!*cookie)
+      break;
+
+    // Copy the name...
+    for (ptr = current, end = current + sizeof(current) - 1; *cookie && *cookie != '=';)
+    {
+      if (ptr < end)
+        *ptr++ = *cookie++;
+      else
+	cookie ++;
+    }
+
+    if (*cookie != '=')
+      break;
+
+    *ptr = '\0';
+    match = !strcmp(current, name);
+    cookie ++;
+
+    // Then the value...
+    if (*cookie == '\"')
+    {
+      // Copy quoted value...
+      for (cookie ++, ptr = buffer, end = buffer + bufsize - 1; *cookie && *cookie != '\"';)
+      {
+        if (match && ptr < end)
+	  *ptr++ = *cookie++;
+	else
+	  cookie ++;
+      }
+
+      if (*cookie == '\"')
+        cookie ++;
+      else
+        match = false;
+    }
+    else
+    {
+      // Copy unquoted value...
+      for (ptr = buffer, end = buffer + bufsize - 1; *cookie && *cookie != ';';)
+      {
+        if (match && ptr < end)
+	  *ptr++ = *cookie++;
+	else
+	  cookie ++;
+      }
+    }
+
+    if (match)
+    {
+      // Got the value we were looking for, nul-terminate and return...
+      *ptr = '\0';
+      return (buffer);
+    }
+
+    // Skip over separator...
+    if (*cookie == ';')
+      cookie ++;
+  }
+
+  // If we get here then we never found the cookie...
+  return (NULL);
+}
+
+
 //
 // 'httpGetEncryption()' - Get the current encryption mode of a connection.
 //

cups/http.h

@@ -456,6 +456,7 @@ extern const char	*httpGetAuthString(http_t *http) _CUPS_PUBLIC;
 extern bool		httpGetBlocking(http_t *http) _CUPS_PUBLIC;
 extern const char	*httpGetContentEncoding(http_t *http) _CUPS_PUBLIC;
 extern const char	*httpGetCookie(http_t *http) _CUPS_PUBLIC;
+extern char		*httpGetCookieValue(http_t *http, const char *name, char *buffer, size_t bufsize) _CUPS_PUBLIC;
 extern const char	*httpGetDateString(time_t t, char *s, size_t slen) _CUPS_PUBLIC;
 extern time_t		httpGetDateTime(const char *s) _CUPS_PUBLIC;
 extern http_encryption_t httpGetEncryption(http_t *http) _CUPS_PUBLIC;

cups/libcups3.def

@@ -1,6 +1,13 @@
 LIBRARY libcups3
 VERSION 3.0
 EXPORTS
+_cups_debug_set
+_cups_gettimeofday
+_cups_hstrerror
+_cups_strcasecmp
+_cups_strcpy
+_cups_strcpy
+_cups_strncasecmp
 _cupsBufferGet
 _cupsBufferRelease
 _cupsConnect
@@ -13,8 +20,8 @@ _cupsGetDests
 _cupsGetPassword
 _cupsGetUserDefault
 _cupsGlobalLock
-_cupsGlobalUnlock
 _cupsGlobals
+_cupsGlobalUnlock
 _cupsJSONDelete
 _cupsMD5Append
 _cupsMD5Finish
@@ -33,13 +40,6 @@ _cupsStrFree
 _cupsStrRetain
 _cupsStrScand
 _cupsStrStatistics
-_cups_debug_set
-_cups_gettimeofday
-_cups_hstrerror
-_cups_strcasecmp
-_cups_strcpy
-_cups_strcpy
-_cups_strncasecmp
 _httpCreateCredentials
 _httpDecodeURI
 _httpDisconnect
@@ -99,6 +99,7 @@ cupsCondWait
 cupsConnectDest
 cupsCopyCredentials
 cupsCopyCredentialsKey
+cupsCopyCredentialsPublicKey
 cupsCopyCredentialsRequest
 cupsCopyDest
 cupsCopyDestConflicts
@@ -109,6 +110,10 @@ cupsCreateCredentialsRequest
 cupsCreateDestJob
 cupsCreateTempFd
 cupsCreateTempFile
+cupsDirClose
+cupsDirOpen
+cupsDirRead
+cupsDirRewind
 cupsDNSSDAssembleFullName
 cupsDNSSDBrowseDelete
 cupsDNSSDBrowseGetContext
@@ -133,10 +138,6 @@ cupsDNSSDServiceGetName
 cupsDNSSDServiceNew
 cupsDNSSDServicePublish
 cupsDNSSDServiceSetLocation
-cupsDirClose
-cupsDirOpen
-cupsDirRead
-cupsDirRewind
 cupsDoAuthentication
 cupsDoFileRequest
 cupsDoIORequest
@@ -177,10 +178,10 @@ cupsFindDestDefault
 cupsFindDestReady
 cupsFindDestSupported
 cupsFinishDestDocument
-cupsFormDecode
-cupsFormEncode
 cupsFormatString
 cupsFormatStringv
+cupsFormDecode
+cupsFormEncode
 cupsFreeDestInfo
 cupsFreeDests
 cupsFreeJobs
@@ -196,8 +197,8 @@ cupsGetDestMediaByName
 cupsGetDestMediaBySize
 cupsGetDestMediaCount
 cupsGetDestMediaDefault
-cupsGetDestWithURI
 cupsGetDests
+cupsGetDestWithURI
 cupsGetEncryption
 cupsGetError
 cupsGetErrorString
@@ -213,9 +214,9 @@ cupsGetResponse
 cupsGetServer
 cupsGetUser
 cupsGetUserAgent
-cupsHMACData
 cupsHashData
 cupsHashString
+cupsHMACData
 cupsJSONAdd
 cupsJSONDelete
 cupsJSONExportFile
@@ -240,17 +241,18 @@ cupsJWTDelete
 cupsJWTExportString
 cupsJWTGetAlgorithm
 cupsJWTGetClaimNumber
+cupsJWTGetClaims
 cupsJWTGetClaimString
 cupsJWTGetClaimType
 cupsJWTGetClaimValue
-cupsJWTGetClaims
 cupsJWTGetHeaderNumber
+cupsJWTGetHeaders
 cupsJWTGetHeaderString
 cupsJWTGetHeaderType
 cupsJWTGetHeaderValue
-cupsJWTGetHeaders
 cupsJWTHasValidSignature
 cupsJWTImportString
+cupsJWTLoadCredentials
 cupsJWTMakePrivateKey
 cupsJWTMakePublicKey
 cupsJWTNew
@@ -289,6 +291,7 @@ cupsOAuthCopyRefreshToken
 cupsOAuthCopyUserId
 cupsOAuthGetAuthorizationCode
 cupsOAuthGetClientId
+cupsOAuthGetJWKS
 cupsOAuthGetMetadata
 cupsOAuthGetTokens
 cupsOAuthMakeAuthorizationURL
@@ -298,11 +301,6 @@ cupsOAuthSaveTokens
 cupsParseOptions
 cupsPutFd
 cupsPutFile
-cupsRWDestroy
-cupsRWInit
-cupsRWLockRead
-cupsRWLockWrite
-cupsRWUnlock
 cupsRasterClose
 cupsRasterGetErrorString
 cupsRasterInitHeader
@@ -315,6 +313,11 @@ cupsRasterWritePixels
 cupsReadResponseData
 cupsRemoveDest
 cupsRemoveOption
+cupsRWDestroy
+cupsRWInit
+cupsRWLockRead
+cupsRWLockWrite
+cupsRWUnlock
 cupsSaveCredentials
 cupsSendRequest
 cupsSetClientCredentials
@@ -374,6 +377,7 @@ httpGetAuthString
 httpGetBlocking
 httpGetContentEncoding
 httpGetCookie
+httpGetCookieValue
 httpGetDateString
 httpGetDateTime
 httpGetEncryption
@@ -387,12 +391,12 @@ httpGetLength
 httpGetPending
 httpGetReady
 httpGetRemaining
+httpGets
 httpGetSecurity
 httpGetState
 httpGetStatus
 httpGetSubField
 httpGetVersion
-httpGets
 httpInitialize
 httpIsChunked
 httpIsEncrypted
@@ -416,8 +420,8 @@ httpSetTimeout
 httpShutdown
 httpStateString
 httpStatusString
-httpURIStatusString
 httpUpdate
+httpURIStatusString
 httpWait
 httpWrite
 httpWriteRequest

doc/cupspm.epub

@@ -607,6 +607,7 @@ <h2 class="title">Contents</h2>
 <li><a href="#httpGetBlocking">httpGetBlocking</a></li>
 <li><a href="#httpGetContentEncoding">httpGetContentEncoding</a></li>
 <li><a href="#httpGetCookie">httpGetCookie</a></li>
+<li><a href="#httpGetCookieValue">httpGetCookieValue</a></li>
 <li><a href="#httpGetDateString">httpGetDateString</a></li>
 <li><a href="#httpGetDateTime">httpGetDateTime</a></li>
 <li><a href="#httpGetEncryption">httpGetEncryption</a></li>
@@ -7781,7 +7782,7 @@ <h4 class="discussion">Discussion</h4>
 client.  The value returned can be use in subsequent requests (for clients)
 or in the response (for servers) in order to compress the content stream.</p>
 <h3 class="function"><a id="httpGetCookie">httpGetCookie</a></h3>
-<p class="description">Get any cookie data from the response.</p>
+<p class="description">Get &quot;Cookie:&quot; data from the HTTP connection.</p>
 <p class="code">
 <span class="reserved">const</span> <span class="reserved">char</span> *httpGetCookie(<a href="#http_t">http_t</a> *http);</p>
 <h4 class="parameters">Parameters</h4>
@@ -7791,6 +7792,31 @@ <h4 class="parameters">Parameters</h4>
 </tbody></table>
 <h4 class="returnvalue">Return Value</h4>
 <p class="description">Cookie data or <code>NULL</code></p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">This function returns any HTTP &quot;Cookie:&quot; header data for the given HTTP
+connection as described in RFC 6265.  Use the <a href="#httpGetCookieValue"><code>httpGetCookieValue</code></a> to
+get the value of a named cookie.</p>
+<h3 class="function"><a id="httpGetCookieValue">httpGetCookieValue</a></h3>
+<p class="description">Get the value of a named cookie from the HTTP connection.</p>
+<p class="code">
+<span class="reserved">char</span> *httpGetCookieValue(<a href="#http_t">http_t</a> *http, <span class="reserved">const</span> <span class="reserved">char</span> *name, <span class="reserved">char</span> *buffer, size_t bufsize);</p>
+<h4 class="parameters">Parameters</h4>
+<table class="list"><tbody>
+<tr><th>http</th>
+<td class="description">HTTP connection</td></tr>
+<tr><th>name</th>
+<td class="description">Cookie name</td></tr>
+<tr><th>buffer</th>
+<td class="description">Value buffer</td></tr>
+<tr><th>bufsize</th>
+<td class="description">Size of value buffer</td></tr>
+</tbody></table>
+<h4 class="returnvalue">Return Value</h4>
+<p class="description">Cookie value or <code>NULL</code> if not present</p>
+<h4 class="discussion">Discussion</h4>
+<p class="discussion">This function copies the value of a named cookie in the HTTP &quot;Cookie:&quot; header
+for the given HTTP connection as described in RFC 6265.  Use the
+<a href="#httpGetCookie"><code>httpGetCookie</code></a> function to get the original &quot;Cookie:&quot; string.</p>
 <h3 class="function"><a id="httpGetDateString">httpGetDateString</a></h3>
 <p class="description">Get a formatted date/time string from a time value.</p>
 <p class="code">