Skip to content

Commit

Permalink
update links in README
Browse files Browse the repository at this point in the history
Signed-off-by: Andrew Whitehead <[email protected]>
  • Loading branch information
andrewwhitehead committed Dec 9, 2024
1 parent 1db756b commit b447426
Showing 1 changed file with 32 additions and 31 deletions.
63 changes: 32 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
# aries-askar
# askar

[![Unit Tests](https://github.com/hyperledger/aries-askar/workflows/Aries-Askar/badge.svg)](https://github.com/hyperledger/aries-askar/actions)
[![Unit Tests](https://github.com/openwallet-foundation/askar/workflows/Aries-Askar/badge.svg)](https://github.com/openwallet-foundation/askar/actions)
[![Rust Crate](https://img.shields.io/crates/v/aries-askar.svg)](https://crates.io/crates/aries-askar)
[![Rust Documentation](https://docs.rs/aries-askar/badge.svg)](https://docs.rs/aries-askar)
[![Python Package](https://img.shields.io/pypi/v/aries_askar)](https://pypi.org/project/aries-askar/)

Aries Askar is a secure (encrypted at rest) storage and a key management service
suitable for use with [Hyperledger Aries] agents and possibly other digital
trust agents. Askar is a replacement implementation (with lessons learned!) of the
Askar is a secure (encrypted at rest) storage and a key management service
suitable for use with [Hyperledger Aries] agents and other digital trust
agents. Askar is a replacement implementation (with lessons learned!) of the
[indy-wallet] part of the [Hyperledger Indy SDK]. Askar has been demonstrated to
be more performant and stable than the Indy SDK when under comparable load.

Askar has a pluggable storage interface that currently supports in-memory (for
testing only), [SQLite] and [PostgreSQL] databases. For details about the
storage scheme used in Askar, please this [storage] overview in the `docs`
folder.
Askar has a pluggable storage interface that currently supports [SQLite] and
[PostgreSQL] databases. For details about the storage scheme used in Askar, please
see this [storage] overview in the `docs` folder.

Askar is implemented in Rust and this repository contains Askar wrappers for
Askar JavaScript and Python, reflecting the key Aries frameworks that embed
Askar, [Aries Framework JavaScript] and [Aries Cloud Agent Python]. Other
wrappers are welcome, although there is some debate as to whether the wrappers
should be within this repository or in their own repository.
Askar is implemented in Rust, with a C-compatible foreign function interface. This
repository contains an additional Askar wrapper for Python. Wrappers for Javascript
and React Native are located in the [askar-wrapper-javascript repository](https://github.com/openwallet-foundation/askar-wrapper-javascript).
These wrappers are used by the [ACA-Py] and [Credo] frameworks respectively. Other
wrappers are welcome.

The name Askar (from the Arabic askar, meaning guard or soldier) is used
The name Askar (from the Arabic askar, meaning "guard" or "soldier") is used
because of the "guard" reference, and because it is an alternate name for the
star [Hamal in the constellation of Aries], the 50th brightest star in our sky.

Expand All @@ -33,7 +32,8 @@ star [Hamal in the constellation of Aries], the 50th brightest star in our sky.
[PostgreSQL]: https://www.postgresql.org/
[storage]: /docs/storage.md
[Aries Framework JavaScript]: https://github.com/hyperledger/aries-framework-javascript
[Aries Cloud Agent Python]: https://github.com/hyperledger/aries-cloudagent-python
[ACA-Py]: https://github.com/openwallet-foundation/acapy
[Credo]: https://github.com/openwallet-foundation/credo-ts
[Hamal in the constellation of Aries]: https://www.star-facts.com/hamal/

## Askar Concepts Borrowed from the indy-wallet Implementation
Expand All @@ -43,44 +43,45 @@ As noted above, Askar is a re-implementation (with lessons learned!) of the
concept documents written about [indy-wallet] apply similarly to Askar. These
are linked here:

* [Encryption and storage passphrases](https://github.com/hyperledger/indy-sdk/blob/main/docs/concepts/default-wallet.md)
* [Object Storage](https://github.com/hyperledger/indy-sdk/blob/main/docs/design/003-wallet-storage/README.md)
* [Storage Import/Export](https://github.com/hyperledger/indy-sdk/blob/main/docs/design/009-wallet-export-import/README.md)
- [Encryption and storage passphrases](https://github.com/hyperledger/indy-sdk/blob/main/docs/concepts/default-wallet.md)
- [Object Storage](https://github.com/hyperledger/indy-sdk/blob/main/docs/design/003-wallet-storage/README.md)
- [Storage Import/Export](https://github.com/hyperledger/indy-sdk/blob/main/docs/design/009-wallet-export-import/README.md)

> **To Do**: These documents should be copied to this repository and updated
> specifically for the Askar implementation.
## Migrating to Aries Askar

If you have an implementation of Aries that is currently based on the [Hyperledger Indy SDK], there are migration tools
built into Askar. The use of these tools is demonstrated in the [Aries Cloud Agent Python] migration tool that can be
found in the [aries-acapy-tools] repository.
If you have an implementation of Aries that is currently based on the
[Hyperledger Indy SDK], there are migration tools built into Askar. The use of these
tools is demonstrated in the [ACA-Py] migration tool that can be found in the
[acapy-tools] repository.

[aries-acapy-tools]: https://github.com/hyperledger/aries-acapy-tools
[aries-acapy-tools]: https://github.com/openwallet-foundation/acapy-tools

## Credit

The initial implementation of `aries-askar` was developed by the Digital Trust
The initial implementation of `askar` was developed by the Digital Trust
team within the Province of British Columbia, and inspired by the wallet design
within [Hyperledger Indy SDK]. To learn
more about BC's Digital Trust Team, and what's happening with decentralized identity in British
Columbia, please go to [Digital Trust website](https://digital.gov.bc.ca/digital-trust/).
within [Hyperledger Indy SDK]. To learn more about BC's Digital Trust Team, and
what's happening with decentralized identity in British Columbia, please go to
[Digital Trust website](https://digital.gov.bc.ca/digital-trust/).

## Contributing

Pull requests are welcome! Please read our [contributions guide](https://github.com/hyperledger/aries-askar/blob/main/CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit signing. See guidance [here](https://github.com/apps/dco).
Pull requests are welcome! Please read our [contributions guide](https://github.com/openwallet-foundation/askar/blob/main/CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit signing. See guidance [here](https://github.com/apps/dco).

We also welcome issues submitted about problems you encounter in using `aries-askar`.
We also welcome issues submitted about problems you encounter in using `askar`.

## License

Licensed under either of

- Apache License, Version 2.0
([LICENSE-APACHE](https://github.com/hyperledger/aries-askar/blob/main/LICENSE-APACHE)
([LICENSE-APACHE](https://github.com/openwallet-foundation/askar/blob/main/LICENSE-APACHE)
or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license
([LICENSE-MIT](https://github.com/hyperledger/aries-askar/blob/main/LICENSE-MIT)
([LICENSE-MIT](https://github.com/openwallet-foundation/askar/blob/main/LICENSE-MIT)
or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT))

at your option.

0 comments on commit b447426

Please sign in to comment.