Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Repo cleanup and licensing. #34

Merged
merged 4 commits into from
Oct 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# https://editorconfig.org

root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

[*.{cjs,js,json,jsonld,mjs,yaml,yml}]
indent_style = space
indent_size = 2
7 changes: 7 additions & 0 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Contact: Digital Bazaar, Inc. <support@digitalbazaar.com>

Files: *.md *json *.hbs .eslintrc.cjs .gitignore package.json .editorconfig
.github/*
Copyright: 2022-2024 Digital Bazaar, Inc.
License: BSD-3-Clause
29 changes: 29 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
BSD 3-Clause License

Copyright (c) 2024, Digital Bazaar, Inc.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

11 changes: 11 additions & 0 deletions LICENSES/BSD-3-Clause.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Copyright (c) <year> <owner>.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,34 +11,38 @@

## Background

Provides interoperability tests for did resolvers that support [did:key Method](https://w3c-ccg.github.io/did-method-key/).
Provides interoperability tests for did resolvers that support
[`did:key` Method](https://w3c-ccg.github.io/did-method-key/).

## Install

```js
npm i
```sh
$ npm i
```

## Usage

```
npm test
```sh
$ npm test
```

## Test Data
Currently our test suite works only with `did:key`s that are `ed25519` compatible.
We will expand to support other formats of `did:key` when those libraries are available.
Currently our test suite works only with `did:key`s that are `ed25519`
compatible. We will expand to support other formats of `did:key` when those
libraries are available.

## Implementation
To add your implementation to this test suite see the [README here.](https://github.com/w3c-ccg/vc-test-suite-implementations)
Add the tag `did-key` to the did resolvers you want tested. Did Resolvers should be their own property in the json manifest:
To add your implementation to this test suite see the
[README here.](https://github.com/w3c-ccg/vc-test-suite-implementations)
Add the tag `did-key` to the did resolvers you want tested. Did Resolvers should
be their own property in the JSON manifest:

```js
"issuers": [{
... issuer settings here
// ... issuer settings here
}],
"verifiers": [{
... verifier settings here
// ... verifier settings here
}],
"didResolvers": [{
"id": "",
Expand All @@ -47,5 +51,12 @@ Add the tag `did-key` to the did resolvers you want tested. Did Resolvers should
}]
```

To run the tests, some implementations require client secrets
that can be passed as env variables to the test script. To see which ones require client secrets, you can check the [vc-test-suite-implementations](https://github.com/w3c-ccg/vc-test-suite-implementations) library.
To run the tests, some implementations require client secrets that can be passed
as env variables to the test script. To see which ones require client secrets,
you can check the
[vc-test-suite-implementations](https://github.com/w3c-ccg/vc-test-suite-implementations)
library.

## LICENSE

[BSD-3-Clause](LICENSE) Copyright 2022-2024 Digital Bazaar, Inc.
5 changes: 5 additions & 0 deletions tests/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/*!
* Copyright (c) 2022 Digital Bazaar, Inc.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
module.exports = {
env: {
mocha: true
Expand Down
4 changes: 3 additions & 1 deletion tests/10-create.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/*!
* Copyright (c) 2022 Digital Bazaar, Inc. All rights reserved.
* Copyright (c) 2022 Digital Bazaar, Inc.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
import {
assertionVmId,
Expand Down
4 changes: 3 additions & 1 deletion tests/assertions.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/*!
* Copyright (c) 2022 Digital Bazaar, Inc. All rights reserved.
* Copyright (c) 2022 Digital Bazaar, Inc.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
import chai from 'chai';

Expand Down
4 changes: 3 additions & 1 deletion tests/helpers.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
/*!
* Copyright (c) 2022 Digital Bazaar, Inc. All rights reserved.
* Copyright (c) 2022 Digital Bazaar, Inc.
*
* SPDX-License-Identifier: BSD-3-Clause
*/

/**
Expand Down
5 changes: 5 additions & 0 deletions tests/mock.data.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/*!
* Copyright (c) 2022 Digital Bazaar, Inc.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
// default valid bs58 ed25519 did
export const did = 'did:key:z6MktKwz7Ge1Yxzr4JHavN33wiwa8y81QdcMRLXQsrH9T53b';
// The id of the keyAgreementKey used for encryption verification
Expand Down