summaryrefslogtreecommitdiff
path: root/std/jwt/README.md
diff options
context:
space:
mode:
authorKitson Kelly <me@kitsonkelly.com>2020-10-26 23:10:48 +1100
committerGitHub <noreply@github.com>2020-10-26 08:10:48 -0400
commit78429496e0625a68ccfdd215c7e240eddb3b5b66 (patch)
tree6dc8d84116e201da44390d4b97b2ca06c8196309 /std/jwt/README.md
parent822e5b653685d539c492b87cf5ae77d0223d9b32 (diff)
revert new std/jwt module so issues can be addressed (#8127)
This reverts commit aa0e64b5794e4515d5e1911107ba54ce7e0dcc3c. This reverts commit 034ab48086557af00216ffe311c71ad4eb0ec4d5.
Diffstat (limited to 'std/jwt/README.md')
-rw-r--r--std/jwt/README.md90
1 files changed, 0 insertions, 90 deletions
diff --git a/std/jwt/README.md b/std/jwt/README.md
deleted file mode 100644
index fe895dafc..000000000
--- a/std/jwt/README.md
+++ /dev/null
@@ -1,90 +0,0 @@
-# jwt
-
-Create and verify JSON Web Tokens.
-
-## JSON Web Token
-
-### create
-
-Takes a `payload`, `key` and `header` and returns the url-safe encoded `token`.
-
-```typescript
-import { create } from "https://deno.land/std@$STD_VERSION/jwt/mod.ts";
-
-const payload = { foo: "bar" };
-const key = "secret";
-
-const token = await create(payload, key); // eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.WePl7achkd0oGNB8XRF_LJwxlyiPZqpdNgdKpDboAjSTsWq-aOGNynTp8TOv8KjonFym8vwFwppXOLoLXbkIaQ
-```
-
-**Specific algorithm**
-
-```typescript
-const token = await create(payload, key, { header: { alg: "HS256" } });
-```
-
-### verify
-
-Takes a `token`, `key` and an optional `options` object and returns the
-`payload` of the `token` if the `token` is valid. Otherwise it throws an
-`Error`.
-
-```typescript
-import { verify } from "https://deno.land/std@$STD_VERSION/jwt/mod.ts";
-
-const token =
- "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.WePl7achkd0oGNB8XRF_LJwxlyiPZqpdNgdKpDboAjSTsWq-aOGNynTp8TOv8KjonFym8vwFwppXOLoLXbkIaQ";
-const key = "secret";
-
-const payload = await verify(token, key); // { foo: "bar" }
-```
-
-**Specific algorithm**
-
-```ts
-const payload = await verify(token, key, { algorithm: "HS256" });
-```
-
-### decode
-
-Takes a `token` to return an object with the `header`, `payload` and `signature`
-properties if the `token` is valid. Otherwise it throws an `Error`.
-
-```typescript
-import { decode } from "https://deno.land/std@$STD_VERSION/jwt/mod.ts";
-
-const token =
- "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.WePl7achkd0oGNB8XRF_LJwxlyiPZqpdNgdKpDboAjSTsWq-aOGNynTp8TOv8KjonFym8vwFwppXOLoLXbkIaQ";
-
-const { payload, signature, header } = await decode(token); // { header: { alg: "HS512", typ: "JWT" }, payload: { foo: "bar" }, signature: "59e3e5eda72191dd2818d07c5d117f2c9c3197288f66aa5d36074aa436e8023493b16abe68e18dca74e9f133aff0a8e89c5ca6f2fc05c29a5738ba0b5db90869" }
-```
-
-## Expiration
-
-The optional **exp** claim in the payload (number of seconds since January 1,
-1970, 00:00:00 UTC) that identifies the expiration time on or after which the
-JWT must not be accepted for processing. This module checks if the current
-date/time is before the expiration date/time listed in the **exp** claim.
-
-```typescript
-const oneHour = 60 * 60;
-const token = await create({ exp: Date.now() + oneHour }, "secret");
-```
-
-## Algorithms
-
-The following signature and MAC algorithms have been implemented:
-
-- HS256 (HMAC SHA-256)
-- HS512 (HMAC SHA-512)
-- none ([_Unsecured JWTs_](https://tools.ietf.org/html/rfc7519#section-6)).
-
-## Serialization
-
-This application uses the JWS Compact Serialization only.
-
-## Specifications
-
-- [JSON Web Token](https://tools.ietf.org/html/rfc7519)
-- [JSON Web Signature](https://www.rfc-editor.org/rfc/rfc7515.html)
-- [JSON Web Algorithms](https://www.rfc-editor.org/rfc/rfc7518.html)