-
Notifications
You must be signed in to change notification settings - Fork 140
/
JwtSession.scala
203 lines (162 loc) · 8.2 KB
/
JwtSession.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
package pdi.jwt
import java.time.Clock
import javax.inject.Inject
import scala.concurrent.duration.Duration
import pdi.jwt.algorithms.{JwtAsymmetricAlgorithm, JwtHmacAlgorithm}
import play.api.Configuration
import play.api.libs.json.*
import play.api.libs.json.Json.JsValueWrapper
/** Similar to the default Play Session but using JsObject instead of Map[String, String]. The data
* is separated into two attributes: `headerData` and `claimData`. There is also a optional
* signature. Most of the time, you should only care about the `claimData` which stores the claim
* of the token containing the custom values you eventually put in it. That's why all methods of
* `JwtSession` (such as add and removing values) only modifiy the `claimData`.
*
* To see a full list of samples, check the
* [[https://jwt-scala.github.io/jwt-scala/jwt-play-jwt-session.html online documentation]].
*
* '''Warning''' Be aware that if you override the `claimData` (using `withClaim` for example), you
* might override some attributes that were automatically put inside the claim such as the
* expiration of the token.
*/
case class JwtSession @Inject() (headerData: JsObject, claimData: JsObject, signature: String)(
implicit
conf: Configuration,
clock: Clock
) {
/** Merge the `value` with `claimData` */
def +(value: JsObject): JwtSession = this.copy(claimData = claimData.deepMerge(value))
/** Add this (key, value) to `claimData` (existing key will be overriden) */
def +(key: String, value: JsValueWrapper): JwtSession = this + Json.obj(key -> value)
/** Convert `value` to its JSON counterpart and add it to `claimData` */
def +[T](key: String, value: T)(implicit writer: Writes[T]): JwtSession =
this + Json.obj(key -> writer.writes(value))
/** Add a sequence of (key, value) to `claimData` */
def ++(fields: (String, JsValueWrapper)*): JwtSession = this + Json.obj(fields: _*)
/** Remove one key from `claimData` */
def -(fieldName: String): JwtSession = this.copy(claimData = claimData - fieldName)
/** Remove a sequence of keys from `claimData` */
def --(fieldNames: String*): JwtSession = this.copy(claimData = fieldNames.foldLeft(claimData) {
(data, fieldName) => (data - fieldName)
})
/** Retrieve the value corresponding to `fieldName` from `claimData` */
def get(fieldName: String): Option[JsValue] = (claimData \ fieldName).toOption
/** After retrieving the value, try to read it as T, if no value or fails, returns None. */
def getAs[T](fieldName: String)(implicit reader: Reads[T]): Option[T] =
get(fieldName).flatMap(value => reader.reads(value).asOpt)
/** Alias of `get` */
def apply(fieldName: String): Option[JsValue] = get(fieldName)
def isEmpty(): Boolean = claimData.keys.isEmpty
def claim: JwtClaim = JwtSession.jwtPlayJsonClaimReader
.reads(claimData)
.recoverTotal(e => throw JwtJson.jsErrorToException(e))
def header: JwtHeader = JwtSession.jwtPlayJsonHeaderReader
.reads(headerData)
.recoverTotal(e => throw JwtJson.jsErrorToException(e))
/** Encode the session as a JSON Web Token */
def serialize: String = {
JwtSession.signingKey match {
// JwtJson.encode doesn't use the implicit clock, so it's safe
// to just default to using the JwtJson object
case Some(k) => JwtJson.encode(headerData, claimData, k)
case _ => JwtJson.encode(headerData, claimData)
}
}
/** Overrride the `claimData` */
def withClaim(claim: JwtClaim): JwtSession =
this.copy(claimData = JwtSession.asJsObject(claim)(JwtSession.jwtPlayJsonClaimWriter))
/** Override the `headerData` */
def withHeader(header: JwtHeader): JwtSession =
this.copy(headerData = JwtSession.asJsObject(header)(JwtSession.jwtPlayJsonHeaderWriter))
/** Override the `signature` (seriously, you should never need this method) */
def withSignature(signature: String): JwtSession = this.copy(signature = signature)
/** If your Play app config has a `session.maxAge`, it will extend the expiration by that amount
*/
def refresh(): JwtSession =
JwtSession.MAX_AGE.map(sec => this + ("exp", JwtTime.nowSeconds + sec)).getOrElse(this)
}
object JwtSession extends JwtJsonImplicits with JwtPlayImplicits {
def REQUEST_HEADER_NAME(implicit conf: Configuration): String =
conf.getOptional[String]("play.http.session.jwtName").getOrElse("Authorization")
def RESPONSE_HEADER_NAME(implicit conf: Configuration): String =
conf.getOptional[String]("play.http.session.jwtResponseName").getOrElse(REQUEST_HEADER_NAME)
// in seconds
def MAX_AGE(implicit conf: Configuration): Option[Long] =
conf.getOptional[Duration]("play.http.session.maxAge").map(_.toSeconds)
def ALGORITHM(implicit conf: Configuration): JwtAlgorithm =
conf
.getOptional[String]("play.http.session.algorithm")
.map(JwtAlgorithm.fromString)
.getOrElse(JwtAlgorithm.HS256)
def TOKEN_PREFIX(implicit conf: Configuration): String =
conf.getOptional[String]("play.http.session.tokenPrefix").getOrElse("Bearer ")
private def secretKey(implicit conf: Configuration): Option[String] =
conf.getOptional[String]("play.http.secret.key")
private def privateKey(implicit conf: Configuration): Option[String] =
conf.getOptional[String]("play.http.session.privateKey")
private def publicKey(implicit conf: Configuration): Option[String] =
conf.getOptional[String]("play.http.session.publicKey")
private def signingKey(implicit conf: Configuration): Option[String] = {
ALGORITHM match {
case _: JwtAsymmetricAlgorithm => privateKey.orElse(secretKey)
case _: JwtHmacAlgorithm => secretKey
case _ => Option.empty
}
}
def deserialize(token: String, options: JwtOptions)(implicit
conf: Configuration,
clock: Clock
): JwtSession = ((ALGORITHM, secretKey, publicKey) match {
case (algorithm: JwtHmacAlgorithm, Some(sk), _) =>
jwtJson.decodeJsonAll(token, sk, Seq(algorithm), options)
case (algorithm: JwtAsymmetricAlgorithm, _, Some(pk)) =>
jwtJson.decodeJsonAll(token, pk, Seq(algorithm), options)
case _ => jwtJson.decodeJsonAll(token, options)
}).map { tuple =>
JwtSession(tuple._1, tuple._2, tuple._3)
}.getOrElse(JwtSession())
private def jwtJson(implicit clock: Clock): JwtJsonParser[JwtHeader, JwtClaim] =
// In the majority of cases, the user is just using the default JwtCore.clock.
// If so, we can just use the existing JwtJson instead of constructing a new one.
if (clock eq JwtJson.clock) JwtJson else JwtJson(clock)
def deserialize(token: String)(implicit conf: Configuration, clock: Clock): JwtSession =
deserialize(token, JwtOptions.DEFAULT)
private def asJsObject[A](value: A)(implicit writer: Writes[A]): JsObject =
writer.writes(value) match {
case value: JsObject => value
case _ => Json.obj()
}
def defaultHeader(implicit conf: Configuration): JwtHeader =
signingKey.map(_ => JwtHeader(ALGORITHM)).getOrElse(JwtHeader())
def defaultClaim(implicit conf: Configuration, clock: Clock): JwtClaim = MAX_AGE match {
case Some(seconds) => JwtClaim().expiresIn(seconds)
case _ => JwtClaim()
}
def apply(jsClaim: JsObject)(implicit conf: Configuration, clock: Clock): JwtSession =
JwtSession.apply(asJsObject(defaultHeader), jsClaim)
def apply(
fields: (String, JsValueWrapper)*
)(implicit conf: Configuration, clock: Clock): JwtSession =
if (fields.isEmpty) {
JwtSession.apply(defaultHeader, JwtClaim())
} else {
JwtSession.apply(Json.obj(fields: _*))
}
def apply(jsHeader: JsObject, jsClaim: JsObject)(implicit
conf: Configuration,
clock: Clock
): JwtSession =
new JwtSession(jsHeader, jsClaim, "").refresh()
def apply(claim: JwtClaim)(implicit conf: Configuration, clock: Clock): JwtSession =
JwtSession.apply(defaultHeader, claim)
def apply(header: JwtHeader, claim: JwtClaim)(implicit
conf: Configuration,
clock: Clock
): JwtSession =
new JwtSession(asJsObject(header), asJsObject(claim), "").refresh()
def apply(header: JwtHeader, claim: JwtClaim, signature: String)(implicit
conf: Configuration,
clock: Clock
): JwtSession =
new JwtSession(asJsObject(header), asJsObject(claim), signature).refresh()
}