Commit e7df2931 authored by tizgafa's avatar tizgafa
Browse files

Initial commit

parents
Pipeline #86026443 passed with stage
in 2 minutes and 33 seconds
.idea
Cargo.lock
target
pkg
*/Cargo.lock
*/target
*/pkg
\ No newline at end of file
#test:stable:
# image: rust:latest
# script:
# - rustc --version && cargo --version
# - rustup component add rustfmt
# - cargo check
# - cargo fmt -- --check
# - cargo test
test:nightly:
image: rustlang/rust:nightly
script:
- rustc --version && cargo --version
- cargo test
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at riendo.contributions@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
\ No newline at end of file
[package]
name = "caelum-vcdm"
version = "0.1.0"
authors = ["Caelum-Labs <alex@caelumlabs.com>"]
edition = "2018"
readme = "../README.md"
[lib]
name = "caelum_vcdm"
path = "src/lib.rs"
crate-type = ["lib", "cdylib"]
[dependencies]
wasm-bindgen = { version = "0.2", features = ["serde-serialize"]}
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
[dev-dependencies]
wasm-bindgen-test = "0.2"
[profile.release]
opt-level = "s"
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2019 Caelum Labs
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Copyright (c) 2019 Caelum Labs
Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
# **V**erifiable **C**redential **D**ata **M**odel [WIP]
This crates implements w3's [Verifiable Credential Data Model](https://www.w3.org/TR/verifiable-claims-data-model/)
specifications.
This means it will create, read, update and delete (a.k.a. CRUD) all properties of a
`Verifiable Credential`and a `Verifiable Presentation`. As well as interacting with other
`Verifiable Credential` and `Verifiable Presentation`.
> A `Verifiable Credential` or a `Verifiable Presentation` can represent all of the same
information that a physical credential represents. The addition of technologies, such as
digital signatures, makes verifiable credentials more tamper-evident and more trustworthy
than their physical counterparts.
> In the physical world, a credential might consist of:
- Information related to identifying the subject of the credential (for example, a photo, name,
or identification number)
- Information related to the issuing authority (for example, a city government, national
agency, or certification body)
- Information related to the type of credential this is (for example, a Dutch passport, an
American driving license, or a health insurance card)
- Information related to specific attributes or properties being asserted by the issuing
authority about the subject (for example, nationality, the classes of vehicle entitled to
drive, or date of birth)
- Evidence related to how the credential was derived
- Information related to constraints on the credential (for example, expiration date, or terms
of use).
We want to help developers create these scenarios and making it easy to interact with other
following the same specifications.
## Getting started with `JavaScript`
```javascript
import {
VPresentation,
VCredential
} from 'vcdm';
// Contructing a Verifiable Credential
let vc = new VCredential("my_id")
// Setters overwrite values of property
.setIssuanceDate("2010-01-01T19:73:24Z")
.setIssuer("Issuer")
.setCredentialSubject({"credentialSubject": {
"type": "parental_admission",
"name": "parent_name",
"field_trip": "Sagrada Familia",
"permission": "true",
}})
// Setting another credential totally different and defined by user
.setSredentialSubject({"credentialSubject": {
"type": "my_id",
"name": "my_name",
"mnumber": "my_number",
"address": "my_address",
"birthDate": "my_birth_date",
}})
.setProof({
"type": "RsaSignature2018",
"created": "2018-06-17T10:03:48Z",
"verificationMethod": "did:example:ebfeb1276e12ec21f712ebc6f1c#k1",
"signatureValue": "pY9...Cky6Ed = "
})
// Adders push values to the vector properties
.addContext("added context")
.addType("added type")
.addPublicKey({
"id": "did:example:ebfeb1276e12ec21f712ebc6f1c",
"type": "OpenIdConnectVersion1.0Service",
"controller": "CONTROLLER!",
"PublicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
})
.addService({
"id": "did:ser:18y34b91c612c4123gwrh45y",
"type": "service_type",
"serviceEndpoint": "www.caelumlabs.com/api/"
});
console.log(vc.toJSON());
// Contructing a Verifiable Presentation
let vp = new VPresentation("my_id")
.addContext("added Context")
.addType("added type")
// Add the created Verifiable Credential
.addVerifiableCredential(vc.toJSON())
.setProof({
"type": "RsaSignature2018",
"created": "2018-06-17T10:03:48Z",
"verificationMethod": "did:example:ebfeb1276e12ec21f712ebc6f1c#k1",
"signatureValue": "pY9...Cky6Ed = "
});
console.log(vp.toJSON());
```
or...
```javascript
import { VPresentation } from 'vcdm';
let vp_json = {
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
],
"id": "did:example:ebfeb1276e12ec21f712ebc6f1c",
"type": [
"VerifiableCredential",
"PersonalInformation"
],
"verifiableCredential": [
{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
],
"id": "http://example.com/credentials/4643",
"type": [
"VerifiableCredential",
"PersonalInformation"
],
"issuer": "did:example:ebfeb1276e12ec21f712ebc6f1c",
"issuanceDate": "2010-01-01T19:73:24Z",
"credentialSubject": {
"type": "did:example:abfab3f512ebc6c1c22de17ec77",
"name": "Mr John Doe",
"mnumber": "77373737373A",
"address": "10 Some Street, Anytown, ThisLocal, Country X",
"birthDate": "1982-02-02-00T00:00Z"
},
"proof": {
"type": "RsaSignature2018",
"created": "2018-06-17T10:03:48Z",
"verificationMethod": "did:example:ebfeb1276e12ec21f712ebc6f1c#k1",
"signatureValue": "pY9...Cky6Ed = "
},
"publicKey": [
{
"id": "did:example:ebfeb1276e12ec21f712ebc6f1c#keys-2",
"controller": "did:example:pqrstuvwxyz0987654321",
"type": "Ed25519VerificationKey2018",
"PublicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV"
}
],
"authentication": [
"did:example:ebfeb1276e12ec21f712ebc6f1c",
{
"PublicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV",
"controller": "did:example:pqrstuvwxyz0987654321",
"id": "keys-2",
"type": "Ed25519VerificationKey2018"
}
],
"service": [
{
"id": "openid",
"type": "OpenIdConnectVersion1.0Service",
"serviceEndpoint": "https://openid.example.com/"
},
{
"id": "openid",
"type": "OpenIdConnectVersion1.0Service",
"serviceEndpoint": "https://openid.example.com/"
}
]
}
],
"proof": {
"type": "RsaSignature2018",
"created": "2018-06-17T10:03:48Z",
"verificationMethod": "did:example:ebfeb1276e12ec21f712ebc6f1c#k1",
"signatureValue": "pY9...Cky6Ed = "
}
};
let vp = VPresentation.fromJSON(vp_json);
console.log(vp.toJSON());
```
## Getting started with `Rust`
```rust
let vc_json_str = r#"{
"@context": [
"https://www.w3.org/2018/credentials/v1",
"https://www.w3.org/2018/credentials/examples/v1"
],
"id": "http://example.com/credentials/4643",
"type": [
"VerifiableCredential",
"PersonalInformation"
],
"issuer": "did:example:ebfeb1276e12ec21f712ebc6f1c",
"issuanceDate": "2010-01-01T19:73:24Z",
"credentialStatus": {
"id": "cred_stat_id",
"type": "cred_stat_credential_subject_type"
},
"credentialSubject": [{
"type": "did:example:abfab3f512ebc6c1c22de17ec77",
"name": "Mr John Doe",
"mnumber": "77373737373A",
"address": "10 Some Street, Anytown, ThisLocal, Country X",
"birthDate": "1982-02-02-00T00:00Z"
}],
"proof": {
"type": "RsaSignature2018",
"created": "2018-06-17T10:03:48Z",
"verificationMethod": "did:example:ebfeb1276e12ec21f712ebc6f1c#k1",
"signatureValue": "pY9...Cky6Ed = "
}
}"#;
let _ver_cred_from_json: VerifiableCredential = serde_json::from_str(vc_json_str).unwrap();
```
Equivalent to:
```rust
let mut ver_cred_vcdm =
VerifiableCredential::new("http://example.com/credentials/4643".to_string());
ver_cred_vcdm.set_proof(
serde_json::from_str(r#"{
"type": "RsaSignature2018",
"created": "2018-06-17T10:03:48Z",
"verificationMethod": "did:example:ebfeb1276e12ec21f712ebc6f1c#k1",
"signatureValue": "pY9...Cky6Ed = "
}"#).unwrap()
);
ver_cred_vcdm.set_credential_subject(
serde_json::from_str(r#"{
"type": "did:example:abfab3f512ebc6c1c22de17ec77",
"name": "Mr John Doe",
"mnumber": "77373737373A",
"address": "10 Some Street, Anytown, ThisLocal, Country X",
"birthDate": "1982-02-02-00T00:00Z"
}"#).unwrap()
);
ver_cred_vcdm.set_issuance_date("2010-01-01T19:73:24Z".to_string());
ver_cred_vcdm.set_issuer("did:example:ebfeb1276e12ec21f712ebc6f1c".to_string());
ver_cred_vcdm.set_credential_status(
serde_json::from_str(r#"{
"id": "cred_stat_id",
"type": "cred_stat_credential_subject_type"
}"#).unwrap(),
);
```
## Roadmap
- [ X ] Basic CRUD implementation on properties.
- [ ] Basic CRUD implementation on Optional properties.
- [ ] Implementation of Roles (`Issuer`, `Holder`, `Verifier`, etc.).
- [ ] Connecting to `Verifiable Data Registry`.
- [ ] Validation for all properties.
- [ ] Verifying basic cryptographic proofs.
- [ ] Implementation of Zero-Knowledge proof.
## Contributing
Please, contribute to `vcdm`! The more the better! Feel free to to open an issue and/or contacting directly with the
owner for any request or suggestion.
## Acknowledgment
This library is created to satisfy w3's specifications.
## Code of conduct
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
[http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
## License
This project is distributed under the terms of both the Apache License (Version 2.0) and the MIT license, specified in
[LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) respectively.
environment:
matrix:
- TARGET: x86_64-pc-windows-msvc
OTHER_TARGET: i686-pc-windows-msvc
MAKE_TARGETS: test-unit-x86_64-pc-windows-msvc
install:
- appveyor-retry appveyor DownloadFile https://win.rustup.rs/ -FileName rustup-init.exe
- rustup-init.exe -y --default-host x86_64-pc-windows-msvc --default-toolchain stable
- set PATH=%PATH%;C:\Users\appveyor\.cargo\bin
- rustup target add %OTHER_TARGET%
- rustup component add rustfmt
- rustc -V
- cargo -V
clone_depth: 1
build: false