diff --git a/Cargo.lock b/Cargo.lock index a2488b41c..78e643e9e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -185,7 +185,7 @@ dependencies = [ [[package]] name = "aries-askar" -version = "0.4.2" +version = "0.4.3" dependencies = [ "askar-crypto", "askar-storage", @@ -205,7 +205,7 @@ dependencies = [ [[package]] name = "askar-crypto" -version = "0.3.4" +version = "0.3.5" dependencies = [ "aead", "aes", @@ -247,7 +247,7 @@ dependencies = [ [[package]] name = "askar-storage" -version = "0.2.1" +version = "0.2.2" dependencies = [ "arc-swap", "askar-crypto", diff --git a/Cargo.toml b/Cargo.toml index c58b80802..54c356317 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -7,12 +7,12 @@ name = "aries-askar" version = "0.4.3" authors = ["Hyperledger Aries Contributors "] edition = "2021" -description = "Hyperledger Aries Askar secure storage" +description = "Askar cryptographic primitives and secure storage" license = "MIT OR Apache-2.0" readme = "README.md" -repository = "https://github.com/hyperledger/aries-askar/" +repository = "https://github.com/openwallet-foundation/askar/" categories = ["cryptography", "database"] -keywords = ["hyperledger", "aries", "ssi", "verifiable", "credentials"] +keywords = ["encryption", "signatures", "ssi", "verifiable", "credentials"] rust-version = "1.81" [package.metadata.docs.rs] diff --git a/askar-crypto/README.md b/askar-crypto/README.md index 9c86b63cc..cda7802c1 100644 --- a/askar-crypto/README.md +++ b/askar-crypto/README.md @@ -3,7 +3,7 @@ [![Rust Crate](https://img.shields.io/crates/v/askar-crypto.svg)](https://crates.io/crates/askar-crypto) [![Rust Documentation](https://docs.rs/askar-crypto/badge.svg)](https://docs.rs/askar-crypto) -The `askar-crypto` crate provides the basic key representations and cryptographic operations used by [`aries-askar`](https://github.com/hyperledger/aries-askar). +The `askar-crypto` crate provides the basic key representations and cryptographic operations used by [`Askar`](https://github.com/openwallet-foundation/askar). ## Supported Key Types @@ -37,7 +37,7 @@ This crate supports the optional `alloc` feature, gating types and operations th Licensed under either of -- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/hyperledger/aries-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) or http://opensource.org/licenses/MIT) +- Apache License, Version 2.0 ([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/openwallet-foundation/askar/blob/main/LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. diff --git a/askar-crypto/src/lib.rs b/askar-crypto/src/lib.rs index 4c2a006c1..5227f2ce8 100644 --- a/askar-crypto/src/lib.rs +++ b/askar-crypto/src/lib.rs @@ -1,4 +1,4 @@ -//! Cryptography primitives and operations for aries-askar. +//! Cryptography primitives and operations for Askar. #![no_std] #![cfg_attr(docsrs, feature(doc_cfg))] diff --git a/askar-storage/Cargo.toml b/askar-storage/Cargo.toml index aef2f6a6e..002adb988 100644 --- a/askar-storage/Cargo.toml +++ b/askar-storage/Cargo.toml @@ -3,12 +3,12 @@ name = "askar-storage" version = "0.2.2" authors = ["Hyperledger Aries Contributors "] edition = "2021" -description = "Hyperledger Aries Askar secure storage" +description = "Askar secure storage support" license = "MIT OR Apache-2.0" readme = "README.md" -repository = "https://github.com/hyperledger/aries-askar/" +repository = "https://github.com/openwallet-foundation/askar/" categories = ["cryptography", "database"] -keywords = ["hyperledger", "aries", "ssi", "verifiable", "credentials"] +keywords = ["encryption", "signatures", "ssi", "verifiable", "credentials"] rust-version = "1.81" [package.metadata.docs.rs] diff --git a/askar-storage/README.md b/askar-storage/README.md index 0cd65feba..09499fbfd 100644 --- a/askar-storage/README.md +++ b/askar-storage/README.md @@ -3,13 +3,13 @@ [![Rust Crate](https://img.shields.io/crates/v/askar-storage.svg)](https://crates.io/crates/askar-storage) [![Rust Documentation](https://docs.rs/askar-storage/badge.svg)](https://docs.rs/askar-storage) -The `askar-storage` crate provides storage backends for use by [`aries-askar`](https://github.com/hyperledger/aries-askar). +The `askar-storage` crate provides storage backends for use by [`Askar`](https://github.com/openwallet-foundation/askar). ## License Licensed under either of -- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/hyperledger/aries-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) or http://opensource.org/licenses/MIT) +- Apache License, Version 2.0 ([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/openwallet-foundation/askar/blob/main/LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. diff --git a/askar-storage/src/backend/mod.rs b/askar-storage/src/backend/mod.rs index ccce181e5..9ecd414b1 100644 --- a/askar-storage/src/backend/mod.rs +++ b/askar-storage/src/backend/mod.rs @@ -1,4 +1,4 @@ -//! Storage backends supported by aries-askar +//! Storage backends supported by askar use std::fmt::Debug; diff --git a/docs/storage.md b/docs/storage.md index 858a5e56a..1a1539f87 100644 --- a/docs/storage.md +++ b/docs/storage.md @@ -75,6 +75,7 @@ Though Aries Askar, via the [SQLx](https://github.com/launchbadge/sqlx) library, [pgBouncer](https://www.pgbouncer.org/) is a lightweight connection pooler for PostgreSQL databases. It acts as an intermediary between the application and the database, proficiently managing connections and alleviating the workload on the database server. By pooling connections and managing them efficiently, pgBouncer improves performance by mitigating connection overhead and resource consumption. To implement pgBouncer with Aries Askar, follow these steps: + 1. Install and configure pgBouncer as per the official documentation and your specific requirements. 2. Update the application's database configuration to point to the pgBouncer endpoint. 3. Monitor and fine-tune pgBouncer settings to optimize performance based on your workload demands. @@ -84,10 +85,11 @@ To implement pgBouncer with Aries Askar, follow these steps: For users of Amazon Web Services (AWS), [RDS Proxy](https://aws.amazon.com/rds/proxy/) provides a managed database proxy service that enhances scalability, availability, and security of database connections. RDS Proxy efficiently manages database connections, transferring the burden of connection management from the database instance to the proxy service. To leverage AWS RDS Proxy in the Aries Askar project: + 1. Set up an RDS Proxy for your Postgres database using the AWS Management Console or AWS CLI. ([Using Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html)) 2. Update the application's database connection configuration to point to the RDS Proxy endpoint. 3. Configure and fine-tune RDS Proxy settings based on your application's requirements and performance metrics. ### Case Study: AWS RDS Proxy Performance Improvement -Refer to [hyperledger/aries-askar#195](https://github.com/hyperledger/aries-askar/issues/195) for in-depth insights and experiences on how AWS RDS Proxy contributed to enhancing database performance within the Aries Askar project. This issue contains valuable information, use cases, and considerations when implementing RDS Proxy. +Refer to [openwallet-foundation/askar#195](https://github.com/openwallet-foundation/askar/issues/195) for in-depth insights and experiences on how AWS RDS Proxy contributed to enhancing database performance within the Aries Askar project. This issue contains valuable information, use cases, and considerations when implementing RDS Proxy. diff --git a/src/ffi/migration.rs b/src/ffi/migration.rs index c397aa843..e14ddf229 100644 --- a/src/ffi/migration.rs +++ b/src/ffi/migration.rs @@ -8,7 +8,7 @@ use super::{ CallbackId, EnsureCallback, }; -/// Migrate an sqlite wallet from an indy-sdk structure to an aries-askar structure. +/// Migrate an sqlite wallet from an indy-sdk structure to an Askar structure. /// It is important to note that this does not do any post-processing. If the record values, tags, /// names, etc. have changed, it must be processed manually afterwards. This script does the following: /// @@ -28,7 +28,7 @@ pub extern "C" fn askar_migrate_indy_sdk( cb_id: CallbackId, ) -> ErrorCode { catch_err!( - trace!("Migrate sqlite wallet from indy-sdk structure to aries-askar"); + trace!("Migrate sqlite wallet from indy-sdk structure to Askar"); let cb = cb.ok_or_else(|| err_msg!("No callback provided"))?; let spec_uri = spec_uri.into_opt_string().ok_or_else(|| err_msg!("No provision spec URI provided"))?; let wallet_name = wallet_name.into_opt_string().ok_or_else(|| err_msg!("No wallet name provided"))?; diff --git a/wrappers/python/README.md b/wrappers/python/README.md index d8779dc76..01191b743 100644 --- a/wrappers/python/README.md +++ b/wrappers/python/README.md @@ -10,7 +10,7 @@ The initial implementation of `aries-askar` was developed by the Verifiable Orga ## Contributing -Pull requests are welcome! Please read our [contributions guide](https://github.com/hyperledger/aries-askar/blob/master/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/master/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`. @@ -18,7 +18,7 @@ We also welcome issues submitted about problems you encounter in using `aries-as Licensed under either of -- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/hyperledger/aries-askar/blob/master/LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) -- MIT license ([LICENSE-MIT](https://github.com/hyperledger/aries-askar/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT) +- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/openwallet-foundation/askar/blob/master/LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](https://github.com/openwallet-foundation/askar/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. diff --git a/wrappers/python/aries_askar/bindings/__init__.py b/wrappers/python/aries_askar/bindings/__init__.py index 2c5ce8ead..08fe807e6 100644 --- a/wrappers/python/aries_askar/bindings/__init__.py +++ b/wrappers/python/aries_askar/bindings/__init__.py @@ -1,4 +1,4 @@ -"""Low-level interaction with the aries-askar library.""" +"""Low-level interaction with the Askar library.""" import asyncio import logging diff --git a/wrappers/python/setup.py b/wrappers/python/setup.py index e86c47048..f9412a87e 100644 --- a/wrappers/python/setup.py +++ b/wrappers/python/setup.py @@ -27,7 +27,7 @@ def parse_requirements(filename: str): author_email="aries@lists.hyperledger.org", long_description=long_description, long_description_content_type="text/markdown", - url="https://github.com/hyperledger/aries-askar", + url="https://github.com/openwallet-foundation/askar", packages=find_packages(), install_requires=parse_requirements("requirements.txt"), tests_require=parse_requirements("requirements.dev.txt"),