Skip to content

Commit

Permalink
(v3.0.0) breaking: corrects poor URI design decision in v2.x.x
Browse files Browse the repository at this point in the history
- removes quotation marks from SSASy URIs
- adds config option to deserialize key as raw key
- adds support for legacy resources
- adds an end-to-end testing
  • Loading branch information
this-oliver committed Sep 9, 2023
1 parent 32a531e commit d968120
Show file tree
Hide file tree
Showing 8 changed files with 796 additions and 441 deletions.
4 changes: 4 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@
}
}
],
// no skipping of tests
"mocha/no-skipped-tests": ["error"],
// no exclusive tests
"mocha/no-exclusive-tests": ["error"],

/* ================ formatting ================ */
// use 2 spaces for indentation
Expand Down
9 changes: 9 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

> Only notable changes are documented here.
## `3.0.0` - Fixes SSASy URI format

- `3.0.0` is essentially a culmination of `2.0.0` and `2.2.0` with some minor changes to the SSASy URI format.
- [breaking] removes quotes from SSASy URI format to avoid issues with URI encoding caused by the quotes. This is a breaking change because it changes the format of the SSASy URI which may cause issues for users who have already stored SSASy URIs in a database, for example.

### Migrating from `2.2.x` to `3.0.0`

- Convert all SSASy URIs back to `RawKey`s using v`2.2.x` and then convert them to SSASy URIs using v`3.0.0`.

## `2.2.2` - SSASy Key URI

- [patch] removes `raw` param from SSASy key URI. The `raw` param was used to indicate whether the key should be deserialized to a `RawKey` object or a `SecureContextKey` object. Since some keys may have the `raw` param while others do not, it can cause issues when searching for keys in a database, for example, since the `raw` param is not part of the key's URI. To solve this minor design issue, the `raw` param has been removed.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@ssasy-auth/core",
"license": "MIT",
"version": "2.2.3",
"version": "3.0.0",
"description": "a self-sovereign authentication scheme",
"author": "[email protected]",
"repository": "ssasy-auth/core",
Expand Down
Loading

0 comments on commit d968120

Please sign in to comment.