CSRF protection using HMAC-signed state tokens (RFC 5869, RFC 2104)
ocaml-linkedin: apply dune fmt
Pure formatting changes from `dune fmt`: doc comment placement moves
from above the binding to below it for `type`s, multi-line `match`
expressions collapse onto one line where they fit, and infix operator
applications pick up spaces (`Soup.($?)` -> `Soup.( $? )`). No
semantic changes.
+32
-1
+25
-1
README.md
+25
-1
README.md
···
4
4
5
5
## Installation
6
6
7
-
`opam install csrf` will install this library.
7
+
Install with opam:
8
+
9
+
```sh
10
+
$ opam install csrf
11
+
```
12
+
13
+
If opam cannot find the package, it may not yet be released in the public
14
+
`opam-repository`. Add the overlay repository, then install it:
15
+
16
+
```sh
17
+
$ opam repo add samoht https://tangled.org/gazagnaire.org/opam-overlay.git
18
+
$ opam update
19
+
$ opam install csrf
20
+
```
8
21
9
22
## Documentation
10
23
24
+
## Example
25
+
26
+
Use a signed state value for OAuth redirects and verify the exact value
27
+
when the browser returns:
28
+
29
+
```ocaml
30
+
let state = Csrf.sign_state ~secret:"server secret" "oauth-login"
31
+
32
+
let authorized =
33
+
Csrf.verify_state ~secret:"server secret" state "oauth-login"
34
+
```
+1
csrf.opam
+1
csrf.opam
+4
dune
+4
dune