tango/cookie.go

680 lines
14 KiB
Go

// Copyright 2015 The Tango Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package tango
import (
"bytes"
"crypto/hmac"
"crypto/sha1"
"encoding/base64"
"fmt"
"io/ioutil"
"net/http"
"strconv"
"strings"
"time"
)
func isValidCookieValue(p []byte) bool {
for _, b := range p {
if b <= ' ' ||
b >= 127 ||
b == '"' ||
b == ',' ||
b == ';' ||
b == '\\' {
return false
}
}
return true
}
func isValidCookieName(s string) bool {
for _, r := range s {
if r <= ' ' ||
r >= 127 ||
strings.ContainsRune(" \t\"(),/:;<=>?@[]\\{}", r) {
return false
}
}
return true
}
type Set interface {
String(key string) (string, error)
Int(key string) (int, error)
Int32(key string) (int32, error)
Int64(key string) (int64, error)
Uint(key string) (uint, error)
Uint32(key string) (uint32, error)
Uint64(key string) (uint64, error)
Float32(key string) (float32, error)
Float64(key string) (float64, error)
Bool(key string) (bool, error)
MustString(key string, defs ...string) string
MustInt(key string, defs ...int) int
MustInt32(key string, defs ...int32) int32
MustInt64(key string, defs ...int64) int64
MustUint(key string, defs ...uint) uint
MustUint32(key string, defs ...uint32) uint32
MustUint64(key string, defs ...uint64) uint64
MustFloat32(key string, defs ...float32) float32
MustFloat64(key string, defs ...float64) float64
MustBool(key string, defs ...bool) bool
}
type Cookies interface {
Set
Get(string) *http.Cookie
Set(*http.Cookie)
Expire(string, time.Time)
Del(string)
}
type cookies Context
var _ Cookies = &cookies{}
func NewCookie(name string, value string, age ...int64) *http.Cookie {
if !isValidCookieName(name) || !isValidCookieValue([]byte(value)) {
return nil
}
var utctime time.Time
if len(age) == 0 {
// 2^31 - 1 seconds (roughly 2038)
utctime = time.Unix(2147483647, 0)
} else {
utctime = time.Unix(time.Now().Unix()+age[0], 0)
}
return &http.Cookie{Name: name, Value: value, Expires: utctime}
}
func (c *cookies) Get(key string) *http.Cookie {
ck, err := c.req.Cookie(key)
if err != nil {
return nil
}
return ck
}
func (c *cookies) Set(ck *http.Cookie) {
http.SetCookie(c.ResponseWriter, ck)
}
func (c *cookies) Expire(key string, expire time.Time) {
ck := c.Get(key)
if ck != nil {
ck.Expires = expire
ck.MaxAge = int(expire.Sub(time.Now()).Seconds())
c.Set(ck)
}
}
func (c *cookies) Del(key string) {
c.Expire(key, time.Date(1900, 1, 1, 0, 0, 0, 0, time.Local))
}
func (c *cookies) String(key string) (string, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return "", err
}
return ck.Value, nil
}
func (c *cookies) Int(key string) (int, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
return strconv.Atoi(ck.Value)
}
func (c *cookies) Int32(key string) (int32, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
v, err := strconv.ParseInt(ck.Value, 10, 32)
return int32(v), err
}
func (c *cookies) Int64(key string) (int64, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
return strconv.ParseInt(ck.Value, 10, 64)
}
func (c *cookies) Uint(key string) (uint, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
v, err := strconv.ParseUint(ck.Value, 10, 64)
return uint(v), err
}
func (c *cookies) Uint32(key string) (uint32, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
v, err := strconv.ParseUint(ck.Value, 10, 32)
return uint32(v), err
}
func (c *cookies) Uint64(key string) (uint64, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
return strconv.ParseUint(ck.Value, 10, 64)
}
func (c *cookies) Float32(key string) (float32, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
v, err := strconv.ParseFloat(ck.Value, 32)
return float32(v), err
}
func (c *cookies) Float64(key string) (float64, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
return strconv.ParseFloat(ck.Value, 32)
}
func (c *cookies) Bool(key string) (bool, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return false, err
}
return strconv.ParseBool(ck.Value)
}
func (c *cookies) MustString(key string, defs ...string) string {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return ""
}
return ck.Value
}
func (c *cookies) MustInt(key string, defs ...int) int {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.Atoi(ck.Value)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *cookies) MustInt32(key string, defs ...int32) int32 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.ParseInt(ck.Value, 10, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return int32(v)
}
func (c *cookies) MustInt64(key string, defs ...int64) int64 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.ParseInt(ck.Value, 10, 64)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *cookies) MustUint(key string, defs ...uint) uint {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.ParseUint(ck.Value, 10, 64)
if len(defs) > 0 && err != nil {
return defs[0]
}
return uint(v)
}
func (c *cookies) MustUint32(key string, defs ...uint32) uint32 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.ParseUint(ck.Value, 10, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return uint32(v)
}
func (c *cookies) MustUint64(key string, defs ...uint64) uint64 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.ParseUint(ck.Value, 10, 64)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *cookies) MustFloat32(key string, defs ...float32) float32 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.ParseFloat(ck.Value, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return float32(v)
}
func (c *cookies) MustFloat64(key string, defs ...float64) float64 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
v, err := strconv.ParseFloat(ck.Value, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *cookies) MustBool(key string, defs ...bool) bool {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return false
}
v, err := strconv.ParseBool(ck.Value)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func getCookieSig(key string, val []byte, timestamp string) string {
hm := hmac.New(sha1.New, []byte(key))
hm.Write(val)
hm.Write([]byte(timestamp))
hex := fmt.Sprintf("%02x", hm.Sum(nil))
return hex
}
// secure cookies
type secureCookies struct {
*cookies
secret string
}
var _ Cookies = &secureCookies{}
func parseSecureCookie(secret string, value string) string {
parts := strings.SplitN(value, "|", 3)
val, timestamp, sig := parts[0], parts[1], parts[2]
if getCookieSig(secret, []byte(val), timestamp) != sig {
return ""
}
ts, _ := strconv.ParseInt(timestamp, 0, 64)
if time.Now().Unix()-31*86400 > ts {
return ""
}
buf := bytes.NewBufferString(val)
encoder := base64.NewDecoder(base64.StdEncoding, buf)
res, _ := ioutil.ReadAll(encoder)
return string(res)
}
func (c *secureCookies) Get(key string) *http.Cookie {
ck := c.cookies.Get(key)
if ck == nil {
return nil
}
v := parseSecureCookie(c.secret, ck.Value)
if v == "" {
return nil
}
ck.Value = v
return ck
}
func (c *secureCookies) String(key string) (string, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return "", err
}
v := parseSecureCookie(c.secret, ck.Value)
return v, nil
}
func (c *secureCookies) Int(key string) (int, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
return strconv.Atoi(s)
}
func (c *secureCookies) Int32(key string) (int32, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseInt(s, 10, 32)
return int32(v), err
}
func (c *secureCookies) Int64(key string) (int64, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
return strconv.ParseInt(s, 10, 64)
}
func (c *secureCookies) Uint(key string) (uint, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseUint(s, 10, 64)
return uint(v), err
}
func (c *secureCookies) Uint32(key string) (uint32, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseUint(s, 10, 32)
return uint32(v), err
}
func (c *secureCookies) Uint64(key string) (uint64, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
return strconv.ParseUint(s, 10, 64)
}
func (c *secureCookies) Float32(key string) (float32, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseFloat(s, 32)
return float32(v), err
}
func (c *secureCookies) Float64(key string) (float64, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return 0, err
}
s := parseSecureCookie(c.secret, ck.Value)
return strconv.ParseFloat(s, 32)
}
func (c *secureCookies) Bool(key string) (bool, error) {
ck, err := c.req.Cookie(key)
if err != nil {
return false, err
}
s := parseSecureCookie(c.secret, ck.Value)
return strconv.ParseBool(s)
}
func (c *secureCookies) MustString(key string, defs ...string) string {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return ""
}
s := parseSecureCookie(c.secret, ck.Value)
return s
}
func (c *secureCookies) MustInt(key string, defs ...int) int {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.Atoi(s)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *secureCookies) MustInt32(key string, defs ...int32) int32 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseInt(s, 10, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return int32(v)
}
func (c *secureCookies) MustInt64(key string, defs ...int64) int64 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseInt(s, 10, 64)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *secureCookies) MustUint(key string, defs ...uint) uint {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseUint(s, 10, 64)
if len(defs) > 0 && err != nil {
return defs[0]
}
return uint(v)
}
func (c *secureCookies) MustUint32(key string, defs ...uint32) uint32 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseUint(s, 10, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return uint32(v)
}
func (c *secureCookies) MustUint64(key string, defs ...uint64) uint64 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseUint(s, 10, 64)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *secureCookies) MustFloat32(key string, defs ...float32) float32 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseFloat(s, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return float32(v)
}
func (c *secureCookies) MustFloat64(key string, defs ...float64) float64 {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return 0
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseFloat(s, 32)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func (c *secureCookies) MustBool(key string, defs ...bool) bool {
ck, err := c.req.Cookie(key)
if err != nil {
if len(defs) > 0 {
return defs[0]
}
return false
}
s := parseSecureCookie(c.secret, ck.Value)
v, err := strconv.ParseBool(s)
if len(defs) > 0 && err != nil {
return defs[0]
}
return v
}
func secCookieValue(secret string, vb []byte) string {
timestamp := strconv.FormatInt(time.Now().Unix(), 10)
sig := getCookieSig(secret, vb, timestamp)
return strings.Join([]string{string(vb), timestamp, sig}, "|")
}
func NewSecureCookie(secret, name string, val string, age ...int64) *http.Cookie {
var buf bytes.Buffer
encoder := base64.NewEncoder(base64.StdEncoding, &buf)
encoder.Write([]byte(val))
encoder.Close()
cookie := secCookieValue(secret, buf.Bytes())
return NewCookie(name, cookie, age...)
}
func (c *secureCookies) Expire(key string, expire time.Time) {
ck := c.Get(key)
if ck != nil {
ck.Expires = expire
ck.Value = secCookieValue(c.secret, []byte(ck.Value))
c.Set(ck)
}
}
func (c *secureCookies) Del(key string) {
c.Expire(key, time.Date(1900, 1, 1, 0, 0, 0, 0, time.Local))
}