{"id":19901866,"url":"https://github.com/openwallet-foundation/askar","last_synced_at":"2025-04-12T04:51:16.088Z","repository":{"id":38039942,"uuid":"262412770","full_name":"openwallet-foundation/askar","owner":"openwallet-foundation","description":"Secure storage designed for Hyperledger Aries agents.","archived":false,"fork":false,"pushed_at":"2025-04-07T17:15:09.000Z","size":5125,"stargazers_count":71,"open_issues_count":33,"forks_count":53,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-11T03:45:59.511Z","etag":null,"topics":["aries","hyperledger-aries","secure-storage","trust-over-ip","verifiable-organizations-network","von"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openwallet-foundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE-APACHE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-08T19:36:51.000Z","updated_at":"2025-04-07T17:15:12.000Z","dependencies_parsed_at":"2024-03-25T14:00:27.020Z","dependency_job_id":"045d49ea-1740-46d1-9b77-6cbf32fe9c00","html_url":"https://github.com/openwallet-foundation/askar","commit_stats":{"total_commits":825,"total_committers":24,"mean_commits":34.375,"dds":0.3224242424242424,"last_synced_commit":"3a4d5044b01d529e77b788cbe08313d0c7b758e6"},"previous_names":["openwallet-foundation/askar","hyperledger/aries-askar"],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwallet-foundation%2Faskar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwallet-foundation%2Faskar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwallet-foundation%2Faskar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openwallet-foundation%2Faskar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openwallet-foundation","download_url":"https://codeload.github.com/openwallet-foundation/askar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248339298,"owners_count":21087213,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aries","hyperledger-aries","secure-storage","trust-over-ip","verifiable-organizations-network","von"],"created_at":"2024-11-12T20:16:26.086Z","updated_at":"2025-04-12T04:51:16.063Z","avatar_url":"https://github.com/openwallet-foundation.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# askar\n\n[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/openwallet-foundation/askar/badge)](https://scorecard.dev/viewer/?uri=github.com/openwallet-foundation/askar)\n[![Unit Tests](https://github.com/openwallet-foundation/askar/workflows/Aries-Askar/badge.svg)](https://github.com/openwallet-foundation/askar/actions)\n[![Rust Crate](https://img.shields.io/crates/v/aries-askar.svg)](https://crates.io/crates/aries-askar)\n[![Rust Documentation](https://docs.rs/aries-askar/badge.svg)](https://docs.rs/aries-askar)\n[![Python Package](https://img.shields.io/pypi/v/aries_askar)](https://pypi.org/project/aries-askar/)\n\nAskar is a secure (encrypted at rest) storage and a key management service\nsuitable for use with [Hyperledger Aries] agents and other digital trust\nagents. Askar is a replacement implementation (with lessons learned!) of the\n[indy-wallet] part of the [Hyperledger Indy SDK]. Askar has been demonstrated to\nbe more performant and stable than the Indy SDK when under comparable load.\n\nAskar has a pluggable storage interface that currently supports [SQLite] and\n[PostgreSQL] databases. For details about the storage scheme used in Askar, please\nsee this [storage] overview in the `docs` folder.\n\nAskar is implemented in Rust, with a C-compatible foreign function interface. This\nrepository contains an additional Askar wrapper for Python. Wrappers for Javascript\nand React Native are located in the [askar-wrapper-javascript repository](https://github.com/openwallet-foundation/askar-wrapper-javascript).\nThese wrappers are used by the [ACA-Py] and [Credo] frameworks respectively. Other\nwrappers are welcome.\n\nThe name Askar (from the Arabic askar, meaning \"guard\" or \"soldier\") is used\nbecause of the \"guard\" reference, and because it is an alternate name for the\nstar [Hamal in the constellation of Aries], the 50th brightest star in our sky.\n\n[Hyperledger Aries]: https://www.hyperledger.org/projects/aries\n[indy-wallet]: https://github.com/hyperledger/indy-sdk/tree/main/libindy/indy-wallet\n[Hyperledger Indy SDK]: https://github.com/hyperledger/indy-sdk\n[SQLite]: https://www.sqlite.org/index.html\n[PostgreSQL]: https://www.postgresql.org/\n[storage]: /docs/storage.md\n[Aries Framework JavaScript]: https://github.com/hyperledger/aries-framework-javascript\n[ACA-Py]: https://github.com/openwallet-foundation/acapy\n[Credo]: https://github.com/openwallet-foundation/credo-ts\n[Hamal in the constellation of Aries]: https://www.star-facts.com/hamal/\n\n## Askar Concepts Borrowed from the indy-wallet Implementation\n\nAs noted above, Askar is a re-implementation (with lessons learned!) of the\n[indy-wallet] part of the [Hyperledger Indy SDK]. As such, a number of the\nconcept documents written about [indy-wallet] apply similarly to Askar. These\nare linked here:\n\n- [Encryption and storage passphrases](https://github.com/hyperledger/indy-sdk/blob/main/docs/concepts/default-wallet.md)\n- [Object Storage](https://github.com/hyperledger/indy-sdk/blob/main/docs/design/003-wallet-storage/README.md)\n- [Storage Import/Export](https://github.com/hyperledger/indy-sdk/blob/main/docs/design/009-wallet-export-import/README.md)\n\n\u003e **To Do**: These documents should be copied to this repository and updated\n\u003e specifically for the Askar implementation.\n\n## Migrating to Aries Askar\n\nIf you have an implementation of Aries that is currently based on the\n[Hyperledger Indy SDK], there are migration tools built into Askar. The use of these\ntools is demonstrated in the [ACA-Py] migration tool that can be found in the\n[acapy-tools] repository.\n\n[acapy-tools]: https://github.com/openwallet-foundation/acapy-tools\n\n## Credit\n\nThe initial implementation of `askar` was developed by the Digital Trust\nteam within the Province of British Columbia, and inspired by the wallet design\nwithin [Hyperledger Indy SDK]. To learn more about BC's Digital Trust Team, and\nwhat's happening with decentralized identity in British Columbia, please go to\n[Digital Trust website](https://digital.gov.bc.ca/digital-trust/).\n\n## Contributing\n\nPull 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).\n\nWe also welcome issues submitted about problems you encounter in using `askar`.\n\n## License\n\nLicensed under either of\n\n- Apache License, Version 2.0\n  ([LICENSE-APACHE](https://github.com/openwallet-foundation/askar/blob/main/LICENSE-APACHE)\n  or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license\n  ([LICENSE-MIT](https://github.com/openwallet-foundation/askar/blob/main/LICENSE-MIT)\n  or [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT))\n\nat your option.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenwallet-foundation%2Faskar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenwallet-foundation%2Faskar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenwallet-foundation%2Faskar/lists"}