;;; ;;; cookie.scm - parse and construct http state information ;;; ;;; Copyright (c) 2000-2024 Shiro Kawai ;;; ;;; Redistribution and use in source and binary forms, with or without ;;; modification, are permitted provided that the following conditions ;;; are met: ;;; ;;; 1. Redistributions of source code must retain the above copyright ;;; notice, this list of conditions and the following disclaimer. ;;; ;;; 2. Redistributions in binary form must reproduce the above copyright ;;; notice, this list of conditions and the following disclaimer in the ;;; documentation and/or other materials provided with the distribution. ;;; ;;; 3. Neither the name of the authors nor the names of its contributors ;;; may be used to endorse or promote products derived from this ;;; software without specific prior written permission. ;;; ;;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ;;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT ;;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR ;;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT ;;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, ;;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED ;;; TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR ;;; PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF ;;; LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING ;;; NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS ;;; SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ;;; ;; Parser and constructor of http "Cookies" defined in ;; RFC 6265 HTTP state managemnet mechanism ;; http://tools.ietf.org/html/rfc6265 ;; See also ;; RFC 2964 Use of HTTP state management ;; ;; The parser also supports the old Netscape spec ;; (define-module rfc.cookie (use scheme.list) (use gauche.threads) (use gauche.sequence) (use srfi.13) (use srfi.19) (use util.match) (export parse-cookie-string construct-cookie-string parse-cookie-date make-cookie-jar cookie-jar-put! cookie-jar-get cookie-jar-purge-ephemeral! ) ) (select-module rfc.cookie) ;;============================================================== ;; Cookie header parser and constructor ;; ;; utility fn. breaks ``attr=value;attr=value ... '' into alist. ;; version is a cookie version. if version>0, we allow comma as the ;; delimiter as well as semicolon. (define (parse-av-pairs input version) (define attr-regexp (if (= version 0) #/\s*([\w$_.-]+)\s*([=\;]\s*)?/ #/\s*([\w$_.-]+)\s*([=\;,]\s*)?/)) (define attr-delim (if (= version 0) #\; #[,\;])) (define (read-attr input r) (cond [(string-null? input) (reverse! r)] [(rxmatch attr-regexp input) => (^m (if (and-let* ([delimiter (rxmatch-substring m 2)]) (string-prefix? "=" delimiter)) (let ([attr (rxmatch-substring m 1)] [rest (rxmatch-after m)]) (if (string-prefix? "\"" rest) (read-token-quoted attr (string-drop rest 1) r) (read-token attr rest r))) (read-attr (rxmatch-after m) (acons (rxmatch-substring m 1) #f r))))] [else ;; the input is broken; for now, we ignore the rest. (reverse! r)])) (define (read-token attr input r) (cond [(string-index input attr-delim) => (^i (read-attr (string-drop input (+ i 1)) (acons attr (string-trim-right (string-take input i)) r)))] [else (reverse! (acons attr (string-trim-right input) r))])) (define (read-token-quoted attr input r) (let loop ([input input] [partial '()]) (cond ([string-index input #[\\\"]] => (^i (let1 c (string-ref input i) (if (char=? c #\\) (if (< (string-length input) (+ i 1)) (error-unterminated attr) (loop (string-drop input (+ i 2)) (list* (string (string-ref input (+ i 1))) (string-take input i) partial))) (read-attr (string-drop input (+ i 1)) (acons attr (string-concatenate-reverse (cons (string-take input i) partial)) r)))))) [else (error-unterminated attr)]))) (define (error-unterminated attr) (error "Unterminated quoted value given for attribute" attr)) (read-attr input '())) ;; Parses the header value of "Cookie" request header. ;; If cookie version is known by "Cookie2" request header, it should ;; be passed to version (as integer). Otherwise, it figures out ;; the cookie version from input. ;; ;; Returns the following format. ;; (( [:path ] [:domain ] [:port ]) ;; ...) (define (parse-cookie-string input . version) (let1 ver (cond [(and (pair? version) (integer? (car version))) (car version)] [(rxmatch #/^\s*$Version\s*=\s*(\d+)/ input) => (^m (string->number (rxmatch-substring m 1)))] [else 0]) (let loop ([av-pairs (parse-av-pairs input ver)] [r '()] [current '()]) (cond [(null? av-pairs) (if (null? current) (reverse r) (reverse (cons (reverse current) r)))] [(string-ci=? "$path" (caar av-pairs)) (loop (cdr av-pairs) r (list* (cdar av-pairs) :path current))] [(string-ci=? "$domain" (caar av-pairs)) (loop (cdr av-pairs) r (list* (cdar av-pairs) :domain current))] [(string-ci=? "$port" (caar av-pairs)) (loop (cdr av-pairs) r (list* (cdar av-pairs) :port current))] [else (if (null? current) (loop (cdr av-pairs) r (list (cdar av-pairs) (caar av-pairs))) (loop (cdr av-pairs) (cons (reverse current) r) (list (cdar av-pairs) (caar av-pairs))))])) )) ;; Construct a cookie string suitable for Set-Cookie or Set-Cookie2 header. ;; specs is the following format. ;; ;; (( ...) ...) ;; ;; Recognized options: ;; :expires ;; The value can be a , a