Skip to content

Commit

Permalink
Merge pull request #355 from andrewwhitehead/fix/repo-url
Browse files Browse the repository at this point in the history
Fix repository URLs and remove Hyperledger references
  • Loading branch information
andrewwhitehead authored Jan 28, 2025
2 parents 7164245 + d8d467f commit f948424
Show file tree
Hide file tree
Showing 12 changed files with 27 additions and 25 deletions.
6 changes: 3 additions & 3 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ name = "aries-askar"
version = "0.4.3"
authors = ["Hyperledger Aries Contributors <[email protected]>"]
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]
Expand Down
6 changes: 3 additions & 3 deletions askar-crypto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion askar-crypto/src/lib.rs
Original file line number Diff line number Diff line change
@@ -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))]
Expand Down
6 changes: 3 additions & 3 deletions askar-storage/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name = "askar-storage"
version = "0.2.2"
authors = ["Hyperledger Aries Contributors <[email protected]>"]
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]
Expand Down
6 changes: 3 additions & 3 deletions askar-storage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion askar-storage/src/backend/mod.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
//! Storage backends supported by aries-askar
//! Storage backends supported by askar
use std::fmt::Debug;

Expand Down
4 changes: 3 additions & 1 deletion docs/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
4 changes: 2 additions & 2 deletions src/ffi/migration.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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:
///
Expand All @@ -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"))?;
Expand Down
6 changes: 3 additions & 3 deletions wrappers/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ 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`.

## License

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.
2 changes: 1 addition & 1 deletion wrappers/python/aries_askar/bindings/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Low-level interaction with the aries-askar library."""
"""Low-level interaction with the Askar library."""

import asyncio
import logging
Expand Down
2 changes: 1 addition & 1 deletion wrappers/python/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def parse_requirements(filename: str):
author_email="[email protected]",
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"),
Expand Down

0 comments on commit f948424

Please sign in to comment.