-
Notifications
You must be signed in to change notification settings - Fork 58
/
SessionDirectives.scala
243 lines (215 loc) · 9.79 KB
/
SessionDirectives.scala
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
package com.softwaremill.session
import akka.http.scaladsl.model.headers.{HttpCookie, `Set-Cookie`}
import akka.http.scaladsl.server.Directives._
import akka.http.scaladsl.server.{Directive0, Directive1}
import com.softwaremill.session.SessionDirectives.respondWithDefaultCookie
import scala.concurrent.ExecutionContext
/**
* Manages cookie-based sessions with optional refresh tokens. A refresh token is written to a separate cookie.
*/
trait SessionDirectives extends OneOffSessionDirectives with RefreshableSessionDirectives {
/**
* Set the session cookie with the session content. The content is signed, optionally encrypted and with
* an optional expiry date.
*
* If refreshable, generates a new token (removing old ones) and stores it in the refresh token cookie.
*/
def setSession[T](sc: SessionContinuity[T], st: SetSessionTransport, v: T): Directive0 = {
sc match {
case _: OneOff[T] => setOneOffSession(sc, st, v)
case r: Refreshable[T] => setRefreshableSession(r, st, v)
}
}
/**
* Read a session from the session cookie, wrapped in [[SessionResult]] describing the possible
* success/failure outcomes.
*
* If refreshable, tries to create a new session based on the refresh token cookie.
*/
def session[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[SessionResult[T]] = {
sc match {
case _: OneOff[T] => oneOffSession(sc, st)
case r: Refreshable[T] => refreshableSession(r, st)
}
}
/**
* Invalidate the session cookie.
*
* If refreshable, also removes the refresh token cookie and the refresh token token (from the client and token
* store), if present.
*
* Note that you should use `refreshable` if you use refreshable systems even only for some users.
*/
def invalidateSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive0 = {
sc match {
case _: OneOff[T] => invalidateOneOffSession(sc, st)
case r: Refreshable[T] => invalidateOneOffSession(sc, st) & invalidateRefreshableSession(r, st)
}
}
/**
* Read an optional session from the session cookie.
*/
def optionalSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[Option[T]] =
session(sc, st).map(_.toOption)
/**
* Read a required session from the session cookie.
*/
def requiredSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[T] =
optionalSession(sc, st).flatMap {
case None => reject(sc.clientSessionManager.sessionMissingRejection)
case Some(data) => provide(data)
}
/**
* Sets the session cookie again with the same data. Useful when using the [[SessionConfig.sessionMaxAgeSeconds]]
* option, as it sets the expiry date anew.
*/
def touchOptionalSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[Option[T]] = {
optionalSession(sc, st).flatMap { d =>
d.fold(pass)(s => setOneOffSessionSameTransport(sc, st, s)) & provide(d)
}
}
/**
* Sets the session cookie again with the same data. Useful when using the [[SessionConfig.sessionMaxAgeSeconds]]
* option, as it sets the expiry date anew.
*/
def touchRequiredSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive1[T] = {
requiredSession(sc, st).flatMap { d =>
setOneOffSessionSameTransport(sc, st, d) & provide(d)
}
}
}
object SessionDirectives extends SessionDirectives {
private[session] def respondWithDefaultCookie(defaultCookie: HttpCookie) =
mapResponseHeaders { headers =>
val cookieExists = headers.exists {
case `Set-Cookie`(c) => c.name == defaultCookie.name
case _ => false
}
if (cookieExists) headers else `Set-Cookie`(defaultCookie) +: headers
}
}
object SessionOptions {
def oneOff[T](implicit manager: SessionManager[T]): OneOff[T] = new OneOff[T]()(manager)
def refreshable[T](implicit
manager: SessionManager[T],
refreshTokenStorage: RefreshTokenStorage[T],
ec: ExecutionContext): Refreshable[T] =
new Refreshable[T]()(manager, refreshTokenStorage, ec)
def usingCookies = CookieST
def usingHeaders = HeaderST
def usingCookiesOrHeaders = CookieOrHeaderST
}
trait OneOffSessionDirectives {
private[session] def setOneOffSession[T](sc: SessionContinuity[T], st: SetSessionTransport, v: T): Directive0 =
st match {
// respondWithDefault* directives let us avoid header/cookie duplication when session has already been set because of refreshable sessions.
case CookieST => respondWithDefaultCookie(sc.clientSessionManager.createCookie(v))
case HeaderST => respondWithDefaultHeader(sc.clientSessionManager.createHeader(v))
}
private[session] def setOneOffSessionSameTransport[T](sc: SessionContinuity[T],
st: GetSessionTransport,
v: T): Directive0 =
read(sc, st).flatMap {
case None => pass
case Some((_, setSt)) => setOneOffSession(sc, setSt, v)
}
private def readCookie[T](sc: SessionContinuity[T]) =
optionalCookie(sc.manager.config.sessionCookieConfig.name)
.map(_.map(c => (c.value, CookieST: SetSessionTransport)))
private def readHeader[T](sc: SessionContinuity[T]) =
optionalHeaderValueByName(sc.manager.config.sessionHeaderConfig.getFromClientHeaderName)
.map(_.map(h => (h, HeaderST: SetSessionTransport)))
private def read[T](sc: SessionContinuity[T],
st: GetSessionTransport): Directive1[Option[(String, SetSessionTransport)]] =
st match {
case CookieST => readCookie(sc)
case HeaderST => readHeader(sc)
case CookieOrHeaderST => readCookie(sc).flatMap(_.fold(readHeader(sc))(v => provide(Some(v))))
}
private[session] def oneOffSession[T](sc: SessionContinuity[T],
st: GetSessionTransport): Directive1[SessionResult[T]] = {
read(sc, st).flatMap {
case None => provide(SessionResult.NoSession)
case Some((v, setSt)) => {
sc.clientSessionManager.decode(v) match {
case s: SessionResult.DecodedLegacy[T] =>
setOneOffSession(sc, setSt, s.session) & provide(s: SessionResult[T])
case s => provide(s)
}
}
}
}
private[session] def invalidateOneOffSession[T](sc: SessionContinuity[T], st: GetSessionTransport): Directive0 = {
readCookie(sc).flatMap {
case None =>
readHeader(sc).flatMap {
case None => pass
case Some(_) => respondWithHeader(sc.clientSessionManager.createHeaderWithValue(""))
}
case Some(_) => deleteCookie(sc.clientSessionManager.createCookieWithValue(""))
}
}
}
trait RefreshableSessionDirectives { this: OneOffSessionDirectives =>
private[session] def setRefreshableSession[T](sc: Refreshable[T], st: SetSessionTransport, v: T): Directive0 = {
setOneOffSession(sc, st, v) & setRefreshToken(sc, st, v)
}
private def readCookie[T](sc: SessionContinuity[T]) =
optionalCookie(sc.manager.config.refreshTokenCookieConfig.name)
.map(_.map(c => (c.value, CookieST: SetSessionTransport)))
private def readHeader[T](sc: SessionContinuity[T]) =
optionalHeaderValueByName(sc.manager.config.refreshTokenHeaderConfig.getFromClientHeaderName)
.map(_.map(h => (h, HeaderST: SetSessionTransport)))
private def read[T](sc: SessionContinuity[T],
st: GetSessionTransport): Directive1[Option[(String, SetSessionTransport)]] =
st match {
case CookieST => readCookie(sc)
case HeaderST => readHeader(sc)
case CookieOrHeaderST => readCookie(sc).flatMap(_.fold(readHeader(sc))(v => provide(Some(v))))
}
private[session] def refreshableSession[T](sc: Refreshable[T],
st: GetSessionTransport): Directive1[SessionResult[T]] = {
import sc.ec
oneOffSession(sc, st).flatMap {
case SessionResult.NoSession | SessionResult.Expired =>
read(sc, st).flatMap {
case None => provide(SessionResult.NoSession)
case Some((v, setSt)) =>
onSuccess(sc.refreshTokenManager.sessionFromValue(v))
.flatMap {
case s @ SessionResult.CreatedFromToken(session) =>
setRefreshableSession(sc, setSt, session) & provide(s: SessionResult[T])
case s => provide(s)
}
}
case s => provide(s)
}
}
private[session] def invalidateRefreshableSession[T](sc: Refreshable[T], st: GetSessionTransport): Directive0 = {
read(sc, st).flatMap {
case None => pass
case Some((v, setSt)) =>
val deleteTokenOnClient = setSt match {
case CookieST => deleteCookie(sc.refreshTokenManager.createCookie("", maxAge = None))
case HeaderST => respondWithHeader(sc.refreshTokenManager.createHeader(""))
}
deleteTokenOnClient &
onSuccess(sc.refreshTokenManager.removeToken(v))
}
}
private def setRefreshToken[T](sc: Refreshable[T], st: SetSessionTransport, v: T): Directive0 = {
import sc.ec
read(sc, st).flatMap { existing =>
val newToken = sc.refreshTokenManager.rotateToken(v, existing.map(_._1))
st match {
// respondWithDefault* directives let us avoid header/cookie duplication when session has already been set because of refreshable sessions.
case CookieST =>
val createCookie = newToken.map(sc.refreshTokenManager.createCookie(_))
onSuccess(createCookie).flatMap(c => respondWithDefaultCookie(c))
case HeaderST =>
val createHeader = newToken.map(sc.refreshTokenManager.createHeader)
onSuccess(createHeader).flatMap(c => respondWithDefaultHeader(c))
}
}
}
}