-
Notifications
You must be signed in to change notification settings - Fork 301
/
cookie.go
119 lines (99 loc) · 2.88 KB
/
cookie.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cookie
import (
"net/http"
"time"
"go.thethings.network/lorawan-stack/v3/pkg/webmiddleware"
)
const (
// tombstone is the cookie tombstone value.
tombstone = "<deleted>"
)
// Cookie is a description of a cookie used for consistent cookie setting and deleting.
type Cookie struct {
// Name is the name of the cookie.
Name string
// Path is path of the cookie.
Path string
// MaxAge is the max age of the cookie.
MaxAge time.Duration
// HTTPOnly restricts the cookie to HTTP (no javascript access).
HTTPOnly bool
}
// Get decodes the cookie into the value. Returns false if the cookie is not there.
func (d *Cookie) Get(w http.ResponseWriter, r *http.Request, v interface{}) (bool, error) {
s, err := webmiddleware.GetSecureCookie(r.Context())
if err != nil {
return false, err
}
cookie, err := r.Cookie(d.Name)
if err != nil || cookie.Value == tombstone {
return false, nil
}
err = s.Decode(d.Name, cookie.Value, v)
if err != nil {
d.Remove(w, r)
return false, nil
}
return true, nil
}
// Set the value of the cookie.
func (d *Cookie) Set(w http.ResponseWriter, r *http.Request, v interface{}) error {
s, err := webmiddleware.GetSecureCookie(r.Context())
if err != nil {
return err
}
str, err := s.Encode(d.Name, v)
if err != nil {
return err
}
http.SetCookie(w, &http.Cookie{
Name: d.Name,
Path: d.Path,
MaxAge: int(d.MaxAge.Nanoseconds() / 1000),
HttpOnly: d.HTTPOnly,
Value: str,
})
return nil
}
// Exists checks if the cookies exists.
func (d *Cookie) Exists(r *http.Request) bool {
cookie, err := r.Cookie(d.Name)
return err == nil && cookie.Value != tombstone
}
// Remove the cookie with the specified name (if it exists).
func (d *Cookie) Remove(w http.ResponseWriter, r *http.Request) {
if !d.Exists(r) {
return
}
http.SetCookie(w, &http.Cookie{
Name: d.Name,
Path: d.Path,
HttpOnly: d.HTTPOnly,
Value: tombstone,
Expires: time.Unix(1, 0),
MaxAge: 0,
})
// Additionally, explicitly remove the cookie also from the current path.
// This can be necessary to also remove old cookies when the cookie paths
// have been changed.
http.SetCookie(w, &http.Cookie{
Name: d.Name,
HttpOnly: d.HTTPOnly,
Value: tombstone,
Expires: time.Unix(1, 0),
MaxAge: 0,
})
}