Debian Codegraph @

docs/html/apreq__cookie_8h.html

raw
1 <html>
2 <head>
3 <link rel="stylesheet" type="text/css" href="dox.css" />
4 <title>libapreq2-2.17: include/apreq_cookie.h File Reference</title>
5 </head>
6 <body>
7 <div id="page-header">
8 <p class="menu">
9 <a href="http://www.apache.org/">Apache Software Foundation</a> &gt; <a href="http://httpd.apache.org">HTTP Server Project</a> &gt;
10 <a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
11 <p class="apache">Apache HTTP Server Request Library</p>
12 <img alt="" src="feather.gif" /></div>
13 <!-- Generated by Doxygen 1.9.1 -->
14 <script type="text/javascript" src="menudata.js"></script>
15 <script type="text/javascript" src="menu.js"></script>
16 <script type="text/javascript">
17 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
18 $(function() {
19 initMenu('',false,false,'search.php','Search');
20 });
21 /* @license-end */</script>
22 <div id="main-nav"></div>
23 <div id="nav-path" class="navpath">
24 <ul>
25 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
26 </div>
27 </div><!-- top -->
28 <div class="header">
29 <div class="summary">
30 <a href="#nested-classes">Data Structures</a> &#124;
31 <a href="#define-members">Macros</a> &#124;
32 <a href="#typedef-members">Typedefs</a> &#124;
33 <a href="#func-members">Functions</a> </div>
34 <div class="headertitle">
35 <div class="title">apreq_cookie.h File Reference<div class="ingroups"><a class="el" href="group__libapreq2.html">Apache Request Library</a></div></div> </div>
36 </div><!--header-->
37 <div class="contents">
38
39 <p>Cookies and Jars.
40 <a href="#details">More...</a></p>
41 <div class="textblock"><code>#include &quot;<a class="el" href="apreq_8h_source.html">apreq.h</a>&quot;</code><br />
42 <code>#include &quot;apr_time.h&quot;</code><br />
43 </div>
44 <p><a href="apreq__cookie_8h_source.html">Go to the source code of this file.</a></p>
45 <table class="memberdecls">
46 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
47 Data Structures</h2></td></tr>
48 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a></td></tr>
49 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cookie type, supporting both Netscape and RFC cookie specifications. <a href="structapreq__cookie__t.html#details">More...</a><br /></td></tr>
50 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
51 </table><table class="memberdecls">
52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
53 Macros</h2></td></tr>
54 <tr class="memitem:a681b8ef60cad05e684876d4dd2be043b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a681b8ef60cad05e684876d4dd2be043b">APREQ_COOKIE_MAX_LENGTH</a>&#160;&#160;&#160;4096</td></tr>
55 <tr class="separator:a681b8ef60cad05e684876d4dd2be043b"><td class="memSeparator" colspan="2">&#160;</td></tr>
56 </table><table class="memberdecls">
57 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
58 Typedefs</h2></td></tr>
59 <tr class="memitem:a40b9ebd9bc37f9019c0091ee97c4c535"><td class="memItemLeft" align="right" valign="top"><a id="a40b9ebd9bc37f9019c0091ee97c4c535"></a>
60 typedef struct <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a40b9ebd9bc37f9019c0091ee97c4c535">apreq_cookie_t</a></td></tr>
61 <tr class="memdesc:a40b9ebd9bc37f9019c0091ee97c4c535"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cookie type, supporting both Netscape and RFC cookie specifications. <br /></td></tr>
62 <tr class="separator:a40b9ebd9bc37f9019c0091ee97c4c535"><td class="memSeparator" colspan="2">&#160;</td></tr>
63 </table><table class="memberdecls">
64 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
65 Functions</h2></td></tr>
66 <tr class="memitem:ab69d56f31d7c8f6f6f598a133817b46e"><td class="memItemLeft" align="right" valign="top">static APR_INLINE <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#ab69d56f31d7c8f6f6f598a133817b46e">apreq_value_to_cookie</a> (const char *val)</td></tr>
67 <tr class="separator:ab69d56f31d7c8f6f6f598a133817b46e"><td class="memSeparator" colspan="2">&#160;</td></tr>
68 <tr class="memitem:a04eaee766e51f143ff2ca4d8a0107004"><td class="memItemLeft" align="right" valign="top">static APR_INLINE unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a04eaee766e51f143ff2ca4d8a0107004">apreq_cookie_version</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
69 <tr class="separator:a04eaee766e51f143ff2ca4d8a0107004"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 <tr class="memitem:aeff5b05ca6b935dd61dcc9da1a047546"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#aeff5b05ca6b935dd61dcc9da1a047546">apreq_cookie_version_set</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c, unsigned v)</td></tr>
71 <tr class="separator:aeff5b05ca6b935dd61dcc9da1a047546"><td class="memSeparator" colspan="2">&#160;</td></tr>
72 <tr class="memitem:a7553c7f54497ce30e1828082c98c813e"><td class="memItemLeft" align="right" valign="top">static APR_INLINE unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a7553c7f54497ce30e1828082c98c813e">apreq_cookie_is_secure</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
73 <tr class="separator:a7553c7f54497ce30e1828082c98c813e"><td class="memSeparator" colspan="2">&#160;</td></tr>
74 <tr class="memitem:a1df7a1ba35cf4c47fc907f40b95fe5e4"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a1df7a1ba35cf4c47fc907f40b95fe5e4">apreq_cookie_secure_on</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
75 <tr class="separator:a1df7a1ba35cf4c47fc907f40b95fe5e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
76 <tr class="memitem:ad9f4813b99b80801ba1dc11d0099ac10"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#ad9f4813b99b80801ba1dc11d0099ac10">apreq_cookie_secure_off</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
77 <tr class="separator:ad9f4813b99b80801ba1dc11d0099ac10"><td class="memSeparator" colspan="2">&#160;</td></tr>
78 <tr class="memitem:a61c3709414b9fe614e32587da8ee8e8a"><td class="memItemLeft" align="right" valign="top">static APR_INLINE unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a61c3709414b9fe614e32587da8ee8e8a">apreq_cookie_is_httponly</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
79 <tr class="separator:a61c3709414b9fe614e32587da8ee8e8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
80 <tr class="memitem:aa9a94a9b03dea7b286a9c4041d3c7e4e"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#aa9a94a9b03dea7b286a9c4041d3c7e4e">apreq_cookie_httponly_on</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
81 <tr class="separator:aa9a94a9b03dea7b286a9c4041d3c7e4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
82 <tr class="memitem:a619cc2d56e20134e91bf1d31ab26bfec"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a619cc2d56e20134e91bf1d31ab26bfec">apreq_cookie_httponly_off</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
83 <tr class="separator:a619cc2d56e20134e91bf1d31ab26bfec"><td class="memSeparator" colspan="2">&#160;</td></tr>
84 <tr class="memitem:a08618139ba29e98cd2327de3f0e961fe"><td class="memItemLeft" align="right" valign="top">static APR_INLINE unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a08618139ba29e98cd2327de3f0e961fe">apreq_cookie_is_tainted</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
85 <tr class="separator:a08618139ba29e98cd2327de3f0e961fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
86 <tr class="memitem:afeec2e0802ae883d4f2fda750b74ca55"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#afeec2e0802ae883d4f2fda750b74ca55">apreq_cookie_tainted_on</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
87 <tr class="separator:afeec2e0802ae883d4f2fda750b74ca55"><td class="memSeparator" colspan="2">&#160;</td></tr>
88 <tr class="memitem:ac3b777e9709fa062ff978afef3867964"><td class="memItemLeft" align="right" valign="top">static APR_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#ac3b777e9709fa062ff978afef3867964">apreq_cookie_tainted_off</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c)</td></tr>
89 <tr class="separator:ac3b777e9709fa062ff978afef3867964"><td class="memSeparator" colspan="2">&#160;</td></tr>
90 <tr class="memitem:a113be08c01bc82605ec52d80c054cbf6"><td class="memItemLeft" align="right" valign="top">apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a113be08c01bc82605ec52d80c054cbf6">apreq_parse_cookie_header</a> (apr_pool_t *pool, apr_table_t *jar, const char *header)</td></tr>
91 <tr class="separator:a113be08c01bc82605ec52d80c054cbf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
92 <tr class="memitem:a53b5bb02baf7fb318cd643fb55820422"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a53b5bb02baf7fb318cd643fb55820422">apreq_cookie_make</a> (apr_pool_t *pool, const char *name, const apr_size_t nlen, const char *value, const apr_size_t vlen)</td></tr>
93 <tr class="separator:a53b5bb02baf7fb318cd643fb55820422"><td class="memSeparator" colspan="2">&#160;</td></tr>
94 <tr class="memitem:a10c1d6639303c3f85fb5818d88e654d3"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a10c1d6639303c3f85fb5818d88e654d3">apreq_cookie_as_string</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c, apr_pool_t *p)</td></tr>
95 <tr class="separator:a10c1d6639303c3f85fb5818d88e654d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
96 <tr class="memitem:afc06d8f5e4ee8530013c4f3c3b12e01f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#afc06d8f5e4ee8530013c4f3c3b12e01f">apreq_cookie_serialize</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c, char *buf, apr_size_t len)</td></tr>
97 <tr class="separator:afc06d8f5e4ee8530013c4f3c3b12e01f"><td class="memSeparator" colspan="2">&#160;</td></tr>
98 <tr class="memitem:a8c6eb3c7c0f003bdc150d2ce99dacc7f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__cookie_8h.html#a8c6eb3c7c0f003bdc150d2ce99dacc7f">apreq_cookie_expires</a> (<a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c, const char *time_str)</td></tr>
99 <tr class="separator:a8c6eb3c7c0f003bdc150d2ce99dacc7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
100 </table>
101 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
102 <div class="textblock"><p>Cookies and Jars. </p>
103 <p><a class="el" href="apreq__cookie_8h.html" title="Cookies and Jars.">apreq_cookie.h</a> describes a common server-side API for request (incoming) and response (outgoing) cookies. It aims towards compliance with the standard cookie specifications listed below.</p>
104 <dl class="section see"><dt>See also</dt><dd><a href="http://wp.netscape.com/newsref/std/cookie_spec.html">http://wp.netscape.com/newsref/std/cookie_spec.html</a> </dd>
105 <dd>
106 <a href="http://www.ietf.org/rfc/rfc2109.txt">http://www.ietf.org/rfc/rfc2109.txt</a> </dd>
107 <dd>
108 <a href="http://www.ietf.org/rfc/rfc2964.txt">http://www.ietf.org/rfc/rfc2964.txt</a> </dd>
109 <dd>
110 <a href="http://www.ietf.org/rfc/rfc2965.txt">http://www.ietf.org/rfc/rfc2965.txt</a> </dd></dl>
111 </div><h2 class="groupheader">Macro Definition Documentation</h2>
112 <a id="a681b8ef60cad05e684876d4dd2be043b"></a>
113 <h2 class="memtitle"><span class="permalink"><a href="#a681b8ef60cad05e684876d4dd2be043b">&#9670;&nbsp;</a></span>APREQ_COOKIE_MAX_LENGTH</h2>
114
115 <div class="memitem">
116 <div class="memproto">
117 <table class="memname">
118 <tr>
119 <td class="memname">#define APREQ_COOKIE_MAX_LENGTH&#160;&#160;&#160;4096</td>
120 </tr>
121 </table>
122 </div><div class="memdoc">
123 <p>This macro is deprecated.</p>
124 <p>Maximum length of a single Set-Cookie(2) header. </p>
125
126 </div>
127 </div>
128 <h2 class="groupheader">Function Documentation</h2>
129 <a id="a10c1d6639303c3f85fb5818d88e654d3"></a>
130 <h2 class="memtitle"><span class="permalink"><a href="#a10c1d6639303c3f85fb5818d88e654d3">&#9670;&nbsp;</a></span>apreq_cookie_as_string()</h2>
131
132 <div class="memitem">
133 <div class="memproto">
134 <table class="memname">
135 <tr>
136 <td class="memname">char* apreq_cookie_as_string </td>
137 <td>(</td>
138 <td class="paramtype">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
139 <td class="paramname"><em>c</em>, </td>
140 </tr>
141 <tr>
142 <td class="paramkey"></td>
143 <td></td>
144 <td class="paramtype">apr_pool_t *&#160;</td>
145 <td class="paramname"><em>p</em>&#160;</td>
146 </tr>
147 <tr>
148 <td></td>
149 <td>)</td>
150 <td></td><td></td>
151 </tr>
152 </table>
153 </div><div class="memdoc">
154 <p>Returns a string that represents the cookie as it would appear in a valid "Set-Cookie*" header.</p>
155 <dl class="params"><dt>Parameters</dt><dd>
156 <table class="params">
157 <tr><td class="paramname">c</td><td>cookie. </td></tr>
158 <tr><td class="paramname">p</td><td>pool which allocates the returned string.</td></tr>
159 </table>
160 </dd>
161 </dl>
162 <dl class="section return"><dt>Returns</dt><dd>header string. </dd></dl>
163
164 </div>
165 </div>
166 <a id="a8c6eb3c7c0f003bdc150d2ce99dacc7f"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#a8c6eb3c7c0f003bdc150d2ce99dacc7f">&#9670;&nbsp;</a></span>apreq_cookie_expires()</h2>
168
169 <div class="memitem">
170 <div class="memproto">
171 <table class="memname">
172 <tr>
173 <td class="memname">void apreq_cookie_expires </td>
174 <td>(</td>
175 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
176 <td class="paramname"><em>c</em>, </td>
177 </tr>
178 <tr>
179 <td class="paramkey"></td>
180 <td></td>
181 <td class="paramtype">const char *&#160;</td>
182 <td class="paramname"><em>time_str</em>&#160;</td>
183 </tr>
184 <tr>
185 <td></td>
186 <td>)</td>
187 <td></td><td></td>
188 </tr>
189 </table>
190 </div><div class="memdoc">
191 <p>Set the Cookie's expiration date.</p>
192 <dl class="params"><dt>Parameters</dt><dd>
193 <table class="params">
194 <tr><td class="paramname">c</td><td>The cookie. </td></tr>
195 <tr><td class="paramname">time_str</td><td>If NULL, the Cookie's expiration date is unset, making it a session cookie. This means no "expires" or "max-age" attribute will appear in the cookie's serialized form. If time_str is not NULL, the expiration date will be reset to the offset (from now) represented by time_str. The time_str should be in a format that <a class="el" href="apreq__util_8h.html#a4e838a92724aa7d9be0b978dc5c4e50c">apreq_atoi64t()</a> can understand, namely /[+-]?\d+\s*[YMDhms]/.</td></tr>
196 </table>
197 </dd>
198 </dl>
199 <dl class="section remark"><dt>Remarks</dt><dd>Now time_str may also be a fixed date; see apr_date_parse_rfc() for admissible formats. </dd></dl>
200
201 </div>
202 </div>
203 <a id="a619cc2d56e20134e91bf1d31ab26bfec"></a>
204 <h2 class="memtitle"><span class="permalink"><a href="#a619cc2d56e20134e91bf1d31ab26bfec">&#9670;&nbsp;</a></span>apreq_cookie_httponly_off()</h2>
205
206 <div class="memitem">
207 <div class="memproto">
208 <table class="mlabels">
209 <tr>
210 <td class="mlabels-left">
211 <table class="memname">
212 <tr>
213 <td class="memname">static APR_INLINE void apreq_cookie_httponly_off </td>
214 <td>(</td>
215 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
216 <td class="paramname"><em>c</em></td><td>)</td>
217 <td></td>
218 </tr>
219 </table>
220 </td>
221 <td class="mlabels-right">
222 <span class="mlabels"><span class="mlabel">static</span></span> </td>
223 </tr>
224 </table>
225 </div><div class="memdoc">
226 <p>Turns off the cookie's HttpOnly flag. </p>
227
228 </div>
229 </div>
230 <a id="aa9a94a9b03dea7b286a9c4041d3c7e4e"></a>
231 <h2 class="memtitle"><span class="permalink"><a href="#aa9a94a9b03dea7b286a9c4041d3c7e4e">&#9670;&nbsp;</a></span>apreq_cookie_httponly_on()</h2>
232
233 <div class="memitem">
234 <div class="memproto">
235 <table class="mlabels">
236 <tr>
237 <td class="mlabels-left">
238 <table class="memname">
239 <tr>
240 <td class="memname">static APR_INLINE void apreq_cookie_httponly_on </td>
241 <td>(</td>
242 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
243 <td class="paramname"><em>c</em></td><td>)</td>
244 <td></td>
245 </tr>
246 </table>
247 </td>
248 <td class="mlabels-right">
249 <span class="mlabels"><span class="mlabel">static</span></span> </td>
250 </tr>
251 </table>
252 </div><div class="memdoc">
253 <p>Sets the cookie's HttpOnly flag, meaning it is not accessible through client-side script in supported browsers. </p>
254
255 </div>
256 </div>
257 <a id="a61c3709414b9fe614e32587da8ee8e8a"></a>
258 <h2 class="memtitle"><span class="permalink"><a href="#a61c3709414b9fe614e32587da8ee8e8a">&#9670;&nbsp;</a></span>apreq_cookie_is_httponly()</h2>
259
260 <div class="memitem">
261 <div class="memproto">
262 <table class="mlabels">
263 <tr>
264 <td class="mlabels-left">
265 <table class="memname">
266 <tr>
267 <td class="memname">static APR_INLINE unsigned apreq_cookie_is_httponly </td>
268 <td>(</td>
269 <td class="paramtype">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
270 <td class="paramname"><em>c</em></td><td>)</td>
271 <td></td>
272 </tr>
273 </table>
274 </td>
275 <td class="mlabels-right">
276 <span class="mlabels"><span class="mlabel">static</span></span> </td>
277 </tr>
278 </table>
279 </div><div class="memdoc">
280 <dl class="section return"><dt>Returns</dt><dd>1 if the HttpOnly flag is set, 0 otherwise. </dd></dl>
281
282 </div>
283 </div>
284 <a id="a7553c7f54497ce30e1828082c98c813e"></a>
285 <h2 class="memtitle"><span class="permalink"><a href="#a7553c7f54497ce30e1828082c98c813e">&#9670;&nbsp;</a></span>apreq_cookie_is_secure()</h2>
286
287 <div class="memitem">
288 <div class="memproto">
289 <table class="mlabels">
290 <tr>
291 <td class="mlabels-left">
292 <table class="memname">
293 <tr>
294 <td class="memname">static APR_INLINE unsigned apreq_cookie_is_secure </td>
295 <td>(</td>
296 <td class="paramtype">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
297 <td class="paramname"><em>c</em></td><td>)</td>
298 <td></td>
299 </tr>
300 </table>
301 </td>
302 <td class="mlabels-right">
303 <span class="mlabels"><span class="mlabel">static</span></span> </td>
304 </tr>
305 </table>
306 </div><div class="memdoc">
307 <dl class="section return"><dt>Returns</dt><dd>1 if the secure flag is set, 0 otherwise. </dd></dl>
308
309 </div>
310 </div>
311 <a id="a08618139ba29e98cd2327de3f0e961fe"></a>
312 <h2 class="memtitle"><span class="permalink"><a href="#a08618139ba29e98cd2327de3f0e961fe">&#9670;&nbsp;</a></span>apreq_cookie_is_tainted()</h2>
313
314 <div class="memitem">
315 <div class="memproto">
316 <table class="mlabels">
317 <tr>
318 <td class="mlabels-left">
319 <table class="memname">
320 <tr>
321 <td class="memname">static APR_INLINE unsigned apreq_cookie_is_tainted </td>
322 <td>(</td>
323 <td class="paramtype">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
324 <td class="paramname"><em>c</em></td><td>)</td>
325 <td></td>
326 </tr>
327 </table>
328 </td>
329 <td class="mlabels-right">
330 <span class="mlabels"><span class="mlabel">static</span></span> </td>
331 </tr>
332 </table>
333 </div><div class="memdoc">
334 <dl class="section return"><dt>Returns</dt><dd>1 if the taint flag is set, 0 otherwise. </dd></dl>
335
336 </div>
337 </div>
338 <a id="a53b5bb02baf7fb318cd643fb55820422"></a>
339 <h2 class="memtitle"><span class="permalink"><a href="#a53b5bb02baf7fb318cd643fb55820422">&#9670;&nbsp;</a></span>apreq_cookie_make()</h2>
340
341 <div class="memitem">
342 <div class="memproto">
343 <table class="memname">
344 <tr>
345 <td class="memname"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a>* apreq_cookie_make </td>
346 <td>(</td>
347 <td class="paramtype">apr_pool_t *&#160;</td>
348 <td class="paramname"><em>pool</em>, </td>
349 </tr>
350 <tr>
351 <td class="paramkey"></td>
352 <td></td>
353 <td class="paramtype">const char *&#160;</td>
354 <td class="paramname"><em>name</em>, </td>
355 </tr>
356 <tr>
357 <td class="paramkey"></td>
358 <td></td>
359 <td class="paramtype">const apr_size_t&#160;</td>
360 <td class="paramname"><em>nlen</em>, </td>
361 </tr>
362 <tr>
363 <td class="paramkey"></td>
364 <td></td>
365 <td class="paramtype">const char *&#160;</td>
366 <td class="paramname"><em>value</em>, </td>
367 </tr>
368 <tr>
369 <td class="paramkey"></td>
370 <td></td>
371 <td class="paramtype">const apr_size_t&#160;</td>
372 <td class="paramname"><em>vlen</em>&#160;</td>
373 </tr>
374 <tr>
375 <td></td>
376 <td>)</td>
377 <td></td><td></td>
378 </tr>
379 </table>
380 </div><div class="memdoc">
381 <p>Returns a new cookie, made from the argument list.</p>
382 <dl class="params"><dt>Parameters</dt><dd>
383 <table class="params">
384 <tr><td class="paramname">pool</td><td>Pool which allocates the cookie. </td></tr>
385 <tr><td class="paramname">name</td><td>The cookie's name. </td></tr>
386 <tr><td class="paramname">nlen</td><td>Length of name. </td></tr>
387 <tr><td class="paramname">value</td><td>The cookie's value. </td></tr>
388 <tr><td class="paramname">vlen</td><td>Length of value.</td></tr>
389 </table>
390 </dd>
391 </dl>
392 <dl class="section return"><dt>Returns</dt><dd>the new cookie </dd></dl>
393
394 </div>
395 </div>
396 <a id="ad9f4813b99b80801ba1dc11d0099ac10"></a>
397 <h2 class="memtitle"><span class="permalink"><a href="#ad9f4813b99b80801ba1dc11d0099ac10">&#9670;&nbsp;</a></span>apreq_cookie_secure_off()</h2>
398
399 <div class="memitem">
400 <div class="memproto">
401 <table class="mlabels">
402 <tr>
403 <td class="mlabels-left">
404 <table class="memname">
405 <tr>
406 <td class="memname">static APR_INLINE void apreq_cookie_secure_off </td>
407 <td>(</td>
408 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
409 <td class="paramname"><em>c</em></td><td>)</td>
410 <td></td>
411 </tr>
412 </table>
413 </td>
414 <td class="mlabels-right">
415 <span class="mlabels"><span class="mlabel">static</span></span> </td>
416 </tr>
417 </table>
418 </div><div class="memdoc">
419 <p>Turns off the cookie's secure flag. </p>
420
421 </div>
422 </div>
423 <a id="a1df7a1ba35cf4c47fc907f40b95fe5e4"></a>
424 <h2 class="memtitle"><span class="permalink"><a href="#a1df7a1ba35cf4c47fc907f40b95fe5e4">&#9670;&nbsp;</a></span>apreq_cookie_secure_on()</h2>
425
426 <div class="memitem">
427 <div class="memproto">
428 <table class="mlabels">
429 <tr>
430 <td class="mlabels-left">
431 <table class="memname">
432 <tr>
433 <td class="memname">static APR_INLINE void apreq_cookie_secure_on </td>
434 <td>(</td>
435 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
436 <td class="paramname"><em>c</em></td><td>)</td>
437 <td></td>
438 </tr>
439 </table>
440 </td>
441 <td class="mlabels-right">
442 <span class="mlabels"><span class="mlabel">static</span></span> </td>
443 </tr>
444 </table>
445 </div><div class="memdoc">
446 <p>Sets the cookie's secure flag, meaning it only comes back over an SSL-encrypted connction. </p>
447
448 </div>
449 </div>
450 <a id="afc06d8f5e4ee8530013c4f3c3b12e01f"></a>
451 <h2 class="memtitle"><span class="permalink"><a href="#afc06d8f5e4ee8530013c4f3c3b12e01f">&#9670;&nbsp;</a></span>apreq_cookie_serialize()</h2>
452
453 <div class="memitem">
454 <div class="memproto">
455 <table class="memname">
456 <tr>
457 <td class="memname">int apreq_cookie_serialize </td>
458 <td>(</td>
459 <td class="paramtype">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
460 <td class="paramname"><em>c</em>, </td>
461 </tr>
462 <tr>
463 <td class="paramkey"></td>
464 <td></td>
465 <td class="paramtype">char *&#160;</td>
466 <td class="paramname"><em>buf</em>, </td>
467 </tr>
468 <tr>
469 <td class="paramkey"></td>
470 <td></td>
471 <td class="paramtype">apr_size_t&#160;</td>
472 <td class="paramname"><em>len</em>&#160;</td>
473 </tr>
474 <tr>
475 <td></td>
476 <td>)</td>
477 <td></td><td></td>
478 </tr>
479 </table>
480 </div><div class="memdoc">
481 <p>Same functionality as apreq_cookie_as_string. Stores the string representation in buf, using up to len bytes in buf as storage. The return value has the same semantics as that of apr_snprintf, including the special behavior for a "len = 0" argument.</p>
482 <dl class="params"><dt>Parameters</dt><dd>
483 <table class="params">
484 <tr><td class="paramname">c</td><td>cookie. </td></tr>
485 <tr><td class="paramname">buf</td><td>storage location for the result. </td></tr>
486 <tr><td class="paramname">len</td><td>size of buf's storage area.</td></tr>
487 </table>
488 </dd>
489 </dl>
490 <dl class="section return"><dt>Returns</dt><dd>size of resulting header string. </dd></dl>
491
492 </div>
493 </div>
494 <a id="ac3b777e9709fa062ff978afef3867964"></a>
495 <h2 class="memtitle"><span class="permalink"><a href="#ac3b777e9709fa062ff978afef3867964">&#9670;&nbsp;</a></span>apreq_cookie_tainted_off()</h2>
496
497 <div class="memitem">
498 <div class="memproto">
499 <table class="mlabels">
500 <tr>
501 <td class="mlabels-left">
502 <table class="memname">
503 <tr>
504 <td class="memname">static APR_INLINE void apreq_cookie_tainted_off </td>
505 <td>(</td>
506 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
507 <td class="paramname"><em>c</em></td><td>)</td>
508 <td></td>
509 </tr>
510 </table>
511 </td>
512 <td class="mlabels-right">
513 <span class="mlabels"><span class="mlabel">static</span></span> </td>
514 </tr>
515 </table>
516 </div><div class="memdoc">
517 <p>Turns off the cookie's tainted flag. </p>
518
519 </div>
520 </div>
521 <a id="afeec2e0802ae883d4f2fda750b74ca55"></a>
522 <h2 class="memtitle"><span class="permalink"><a href="#afeec2e0802ae883d4f2fda750b74ca55">&#9670;&nbsp;</a></span>apreq_cookie_tainted_on()</h2>
523
524 <div class="memitem">
525 <div class="memproto">
526 <table class="mlabels">
527 <tr>
528 <td class="mlabels-left">
529 <table class="memname">
530 <tr>
531 <td class="memname">static APR_INLINE void apreq_cookie_tainted_on </td>
532 <td>(</td>
533 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
534 <td class="paramname"><em>c</em></td><td>)</td>
535 <td></td>
536 </tr>
537 </table>
538 </td>
539 <td class="mlabels-right">
540 <span class="mlabels"><span class="mlabel">static</span></span> </td>
541 </tr>
542 </table>
543 </div><div class="memdoc">
544 <p>Sets the cookie's tainted flag. </p>
545
546 </div>
547 </div>
548 <a id="a04eaee766e51f143ff2ca4d8a0107004"></a>
549 <h2 class="memtitle"><span class="permalink"><a href="#a04eaee766e51f143ff2ca4d8a0107004">&#9670;&nbsp;</a></span>apreq_cookie_version()</h2>
550
551 <div class="memitem">
552 <div class="memproto">
553 <table class="mlabels">
554 <tr>
555 <td class="mlabels-left">
556 <table class="memname">
557 <tr>
558 <td class="memname">static APR_INLINE unsigned apreq_cookie_version </td>
559 <td>(</td>
560 <td class="paramtype">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
561 <td class="paramname"><em>c</em></td><td>)</td>
562 <td></td>
563 </tr>
564 </table>
565 </td>
566 <td class="mlabels-right">
567 <span class="mlabels"><span class="mlabel">static</span></span> </td>
568 </tr>
569 </table>
570 </div><div class="memdoc">
571 <dl class="section return"><dt>Returns</dt><dd>1 if this is an RFC cookie, 0 if its a Netscape cookie. </dd></dl>
572
573 </div>
574 </div>
575 <a id="aeff5b05ca6b935dd61dcc9da1a047546"></a>
576 <h2 class="memtitle"><span class="permalink"><a href="#aeff5b05ca6b935dd61dcc9da1a047546">&#9670;&nbsp;</a></span>apreq_cookie_version_set()</h2>
577
578 <div class="memitem">
579 <div class="memproto">
580 <table class="mlabels">
581 <tr>
582 <td class="mlabels-left">
583 <table class="memname">
584 <tr>
585 <td class="memname">static APR_INLINE void apreq_cookie_version_set </td>
586 <td>(</td>
587 <td class="paramtype"><a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td>
588 <td class="paramname"><em>c</em>, </td>
589 </tr>
590 <tr>
591 <td class="paramkey"></td>
592 <td></td>
593 <td class="paramtype">unsigned&#160;</td>
594 <td class="paramname"><em>v</em>&#160;</td>
595 </tr>
596 <tr>
597 <td></td>
598 <td>)</td>
599 <td></td><td></td>
600 </tr>
601 </table>
602 </td>
603 <td class="mlabels-right">
604 <span class="mlabels"><span class="mlabel">static</span></span> </td>
605 </tr>
606 </table>
607 </div><div class="memdoc">
608 <p>Sets the cookie's protocol version. </p>
609
610 </div>
611 </div>
612 <a id="a113be08c01bc82605ec52d80c054cbf6"></a>
613 <h2 class="memtitle"><span class="permalink"><a href="#a113be08c01bc82605ec52d80c054cbf6">&#9670;&nbsp;</a></span>apreq_parse_cookie_header()</h2>
614
615 <div class="memitem">
616 <div class="memproto">
617 <table class="memname">
618 <tr>
619 <td class="memname">apr_status_t apreq_parse_cookie_header </td>
620 <td>(</td>
621 <td class="paramtype">apr_pool_t *&#160;</td>
622 <td class="paramname"><em>pool</em>, </td>
623 </tr>
624 <tr>
625 <td class="paramkey"></td>
626 <td></td>
627 <td class="paramtype">apr_table_t *&#160;</td>
628 <td class="paramname"><em>jar</em>, </td>
629 </tr>
630 <tr>
631 <td class="paramkey"></td>
632 <td></td>
633 <td class="paramtype">const char *&#160;</td>
634 <td class="paramname"><em>header</em>&#160;</td>
635 </tr>
636 <tr>
637 <td></td>
638 <td>)</td>
639 <td></td><td></td>
640 </tr>
641 </table>
642 </div><div class="memdoc">
643 <p>Parse a cookie header and store the cookies in an apr_table_t.</p>
644 <dl class="params"><dt>Parameters</dt><dd>
645 <table class="params">
646 <tr><td class="paramname">pool</td><td>pool which allocates the cookies </td></tr>
647 <tr><td class="paramname">jar</td><td>table where parsed cookies are stored </td></tr>
648 <tr><td class="paramname">header</td><td>the header value</td></tr>
649 </table>
650 </dd>
651 </dl>
652 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS. </dd>
653 <dd>
654 <a class="el" href="apreq__error_8h.html#a73a69e21acc2cf849310a421ab43d2ba">APREQ_ERROR_BADSEQ</a> if an unparsable character sequence appears. </dd>
655 <dd>
656 <a class="el" href="apreq__error_8h.html#a33080081185585997ef9c5232ec4dd8f">APREQ_ERROR_MISMATCH</a> if an rfc-cookie attribute appears in a netscape cookie header. </dd>
657 <dd>
658 ::APR_ENOTIMPL if an unrecognized rfc-cookie attribute appears. </dd>
659 <dd>
660 <a class="el" href="apreq__error_8h.html#a59be3610ba54a58fbb3cd6bb655ff972">APREQ_ERROR_NOTOKEN</a> if a required token was not present. </dd>
661 <dd>
662 <a class="el" href="apreq__error_8h.html#a04b6a01738a1ee7fd1ecc79d256e721f">APREQ_ERROR_BADCHAR</a> if an unexpected token was present. </dd></dl>
663
664 </div>
665 </div>
666 <a id="ab69d56f31d7c8f6f6f598a133817b46e"></a>
667 <h2 class="memtitle"><span class="permalink"><a href="#ab69d56f31d7c8f6f6f598a133817b46e">&#9670;&nbsp;</a></span>apreq_value_to_cookie()</h2>
668
669 <div class="memitem">
670 <div class="memproto">
671 <table class="mlabels">
672 <tr>
673 <td class="mlabels-left">
674 <table class="memname">
675 <tr>
676 <td class="memname">static APR_INLINE <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a>* apreq_value_to_cookie </td>
677 <td>(</td>
678 <td class="paramtype">const char *&#160;</td>
679 <td class="paramname"><em>val</em></td><td>)</td>
680 <td></td>
681 </tr>
682 </table>
683 </td>
684 <td class="mlabels-right">
685 <span class="mlabels"><span class="mlabel">static</span></span> </td>
686 </tr>
687 </table>
688 </div><div class="memdoc">
689 <p>Upgrades a jar's table values to <a class="el" href="structapreq__cookie__t.html" title="Cookie type, supporting both Netscape and RFC cookie specifications.">apreq_cookie_t</a> structs. </p>
690
691 </div>
692 </div>
693 </div><!-- contents -->
694 <div id="footer">
695 <p class="apache">
696 Copyright &copy; 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
697 See <a href="apreq_license.html">LICENSE</a>.</p>
698 <p class="menu">
699 <span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
700 version 1.9.1 on Thu Aug 18 2022</span>
701 </p>
702 </div>
703 </body>
704 </html>