You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by er...@apache.org on 2026/07/31 15:22:37 UTC
(opendal-reqsign) branch main updated: docs: add release files to all crates (#814)
This is an automated email from the ASF dual-hosted git repository.
erickguan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal-reqsign.git
The following commit(s) were added to refs/heads/main by this push:
new 91bfb73 docs: add release files to all crates (#814)
91bfb73 is described below
commit 91bfb7318161ccb3ce050add9d9998f3e5827c8d
Author: Erick Guan <29...@users.noreply.github.com>
AuthorDate: Fri Jul 31 23:22:32 2026 +0800
docs: add release files to all crates (#814)
---
context/command-execute-tokio/NOTICE | 1 +
context/command-execute-tokio/README.md | 24 +++++++++++++++++++
context/file-read-tokio/NOTICE | 1 +
context/http-send-reqwest/NOTICE | 1 +
core/NOTICE | 1 +
reqsign/NOTICE | 1 +
services/aliyun-oss/NOTICE | 1 +
services/aws-core/LICENSE | 1 +
services/aws-core/NOTICE | 1 +
services/aws-v4/NOTICE | 1 +
services/aws-v4a/LICENSE | 1 +
services/aws-v4a/NOTICE | 1 +
services/azure-storage/NOTICE | 1 +
services/google/NOTICE | 1 +
services/google/README.md | 41 +++++++++++++++++++++++++++++++++
services/huaweicloud-obs/NOTICE | 1 +
services/huaweicloud-obs/README.md | 34 +++++++++++++++++++++++++++
services/oracle/NOTICE | 1 +
services/oracle/README.md | 37 +++++++++++++++++++++++++++++
services/tencent-cos/NOTICE | 1 +
services/tencent-cos/README.md | 34 +++++++++++++++++++++++++++
services/volcengine-tos/NOTICE | 1 +
services/volcengine-tos/README.md | 29 +++++++++++++++++++++++
23 files changed, 216 insertions(+)
diff --git a/context/command-execute-tokio/NOTICE b/context/command-execute-tokio/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/context/command-execute-tokio/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/context/command-execute-tokio/README.md b/context/command-execute-tokio/README.md
new file mode 100644
index 0000000..c3e3265
--- /dev/null
+++ b/context/command-execute-tokio/README.md
@@ -0,0 +1,24 @@
+# reqsign-command-execute-tokio
+
+Tokio-based command execution for reqsign.
+
+This crate provides `TokioCommandExecute`, an implementation of
+`reqsign_core::CommandExecute` backed by `tokio::process`. It is intended for
+credential providers that invoke external programs, such as AWS credential
+processes and cloud provider CLIs.
+
+## Usage
+
+```rust
+use reqsign_command_execute_tokio::TokioCommandExecute;
+use reqsign_core::Context;
+
+let context = Context::new().with_command_execute(TokioCommandExecute);
+```
+
+Command execution is supported on native targets. On WebAssembly targets the
+implementation returns an unsupported-operation error.
+
+## License
+
+Licensed under [Apache License, Version 2.0](./LICENSE).
diff --git a/context/file-read-tokio/NOTICE b/context/file-read-tokio/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/context/file-read-tokio/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/context/http-send-reqwest/NOTICE b/context/http-send-reqwest/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/context/http-send-reqwest/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/core/NOTICE b/core/NOTICE
new file mode 120000
index 0000000..7e1b82f
--- /dev/null
+++ b/core/NOTICE
@@ -0,0 +1 @@
+../NOTICE
\ No newline at end of file
diff --git a/reqsign/NOTICE b/reqsign/NOTICE
new file mode 120000
index 0000000..7e1b82f
--- /dev/null
+++ b/reqsign/NOTICE
@@ -0,0 +1 @@
+../NOTICE
\ No newline at end of file
diff --git a/services/aliyun-oss/NOTICE b/services/aliyun-oss/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/aliyun-oss/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/aws-core/LICENSE b/services/aws-core/LICENSE
new file mode 120000
index 0000000..30cff74
--- /dev/null
+++ b/services/aws-core/LICENSE
@@ -0,0 +1 @@
+../../LICENSE
\ No newline at end of file
diff --git a/services/aws-core/NOTICE b/services/aws-core/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/aws-core/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/aws-v4/NOTICE b/services/aws-v4/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/aws-v4/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/aws-v4a/LICENSE b/services/aws-v4a/LICENSE
new file mode 120000
index 0000000..30cff74
--- /dev/null
+++ b/services/aws-v4a/LICENSE
@@ -0,0 +1 @@
+../../LICENSE
\ No newline at end of file
diff --git a/services/aws-v4a/NOTICE b/services/aws-v4a/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/aws-v4a/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/azure-storage/NOTICE b/services/azure-storage/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/azure-storage/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/google/NOTICE b/services/google/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/google/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/google/README.md b/services/google/README.md
new file mode 100644
index 0000000..6bfcdcb
--- /dev/null
+++ b/services/google/README.md
@@ -0,0 +1,41 @@
+# reqsign-google
+
+Google Cloud Platform signing implementation for reqsign.
+
+This crate signs Google Cloud requests with OAuth 2.0 access tokens or service
+account credentials. Its default Application Default Credentials chain checks
+`GOOGLE_APPLICATION_CREDENTIALS`, the well-known gcloud credentials file, and
+the Compute Engine metadata service.
+
+## Quick Start
+
+```rust,no_run
+use reqsign_core::{Context, OsEnv, Signer};
+use reqsign_file_read_tokio::TokioFileRead;
+use reqsign_google::{DefaultCredentialProvider, RequestSigner};
+use reqsign_http_send_reqwest::ReqwestHttpSend;
+
+let context = Context::new()
+ .with_file_read(TokioFileRead)
+ .with_http_send(ReqwestHttpSend::default())
+ .with_env(OsEnv);
+
+let signer = Signer::new(
+ context,
+ DefaultCredentialProvider::new(),
+ RequestSigner::new("storage"),
+);
+```
+
+The crate also supports server-side Cloud Storage Credential Access Boundary
+downscoping. Enable the `credential-access-boundary-client-side` feature for
+local client-side token generation.
+
+## Examples
+
+- [Credential-chain logging](examples/chain_logging.rs)
+- [Custom credential chain](examples/custom_chain.rs)
+
+## License
+
+Licensed under [Apache License, Version 2.0](./LICENSE).
diff --git a/services/huaweicloud-obs/NOTICE b/services/huaweicloud-obs/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/huaweicloud-obs/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/huaweicloud-obs/README.md b/services/huaweicloud-obs/README.md
new file mode 100644
index 0000000..8add3fd
--- /dev/null
+++ b/services/huaweicloud-obs/README.md
@@ -0,0 +1,34 @@
+# reqsign-huaweicloud-obs
+
+Huawei Cloud Object Storage Service signing implementation for reqsign.
+
+The default credential provider reads `HUAWEI_CLOUD_ACCESS_KEY_ID` and
+`HUAWEI_CLOUD_SECRET_ACCESS_KEY`, with an optional
+`HUAWEI_CLOUD_SECURITY_TOKEN`.
+
+## Quick Start
+
+```rust,no_run
+use reqsign_core::{Context, OsEnv, Signer};
+use reqsign_huaweicloud_obs::{DefaultCredentialProvider, RequestSigner};
+
+let context = Context::new().with_env(OsEnv);
+let signer = Signer::new(
+ context,
+ DefaultCredentialProvider::new(),
+ RequestSigner::new("bucket"),
+);
+```
+
+Use `StaticCredentialProvider` for credentials supplied directly by an
+application, or `DefaultCredentialProvider::builder()` to replace or remove
+the environment credential slot.
+
+## Examples
+
+- [Credential-chain logging](examples/chain_logging.rs)
+- [Custom credential chain](examples/custom_chain.rs)
+
+## License
+
+Licensed under [Apache License, Version 2.0](./LICENSE).
diff --git a/services/oracle/NOTICE b/services/oracle/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/oracle/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/oracle/README.md b/services/oracle/README.md
new file mode 100644
index 0000000..87bf793
--- /dev/null
+++ b/services/oracle/README.md
@@ -0,0 +1,37 @@
+# reqsign-oracle
+
+Oracle Cloud Infrastructure request signing implementation for reqsign.
+
+The default credential provider checks OCI environment variables and then the
+OCI configuration file at `~/.oci/config`. The config path and profile can be
+selected with `OCI_CONFIG_FILE` and `OCI_PROFILE`.
+
+## Quick Start
+
+```rust,no_run
+use reqsign_core::{Context, OsEnv, Signer};
+use reqsign_file_read_tokio::TokioFileRead;
+use reqsign_oracle::{DefaultCredentialProvider, RequestSigner};
+
+let context = Context::new()
+ .with_file_read(TokioFileRead)
+ .with_env(OsEnv);
+
+let signer = Signer::new(
+ context,
+ DefaultCredentialProvider::new(),
+ RequestSigner::new(),
+);
+```
+
+The environment provider reads `OCI_USER`, `OCI_TENANCY`, `OCI_KEY_FILE`, and
+`OCI_FINGERPRINT`. Use `StaticCredentialProvider` or
+`DefaultCredentialProvider::builder()` for explicit configuration.
+
+## Examples
+
+- [Credential-chain logging](examples/oracle_chain_logging.rs)
+
+## License
+
+Licensed under [Apache License, Version 2.0](./LICENSE).
diff --git a/services/tencent-cos/NOTICE b/services/tencent-cos/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/tencent-cos/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/tencent-cos/README.md b/services/tencent-cos/README.md
new file mode 100644
index 0000000..62c53d3
--- /dev/null
+++ b/services/tencent-cos/README.md
@@ -0,0 +1,34 @@
+# reqsign-tencent-cos
+
+Tencent Cloud Object Storage request signing implementation for reqsign.
+
+The default credential provider checks Tencent Cloud environment variables and
+then web identity configuration. It supports both header authentication and
+presigned query authentication.
+
+## Quick Start
+
+```rust,no_run
+use reqsign_core::{Context, OsEnv, Signer};
+use reqsign_tencent_cos::{DefaultCredentialProvider, RequestSigner};
+
+let context = Context::new().with_env(OsEnv);
+let signer = Signer::new(
+ context,
+ DefaultCredentialProvider::new(),
+ RequestSigner::new(),
+);
+```
+
+Environment credentials use `TENCENTCLOUD_SECRET_ID` and
+`TENCENTCLOUD_SECRET_KEY`, with an optional token in
+`TENCENTCLOUD_TOKEN` or `TENCENTCLOUD_SECURITY_TOKEN`. TKE aliases are also
+supported.
+
+## Examples
+
+- [Credential-chain logging](examples/tencent_chain_logging.rs)
+
+## License
+
+Licensed under [Apache License, Version 2.0](./LICENSE).
diff --git a/services/volcengine-tos/NOTICE b/services/volcengine-tos/NOTICE
new file mode 120000
index 0000000..fb376cf
--- /dev/null
+++ b/services/volcengine-tos/NOTICE
@@ -0,0 +1 @@
+../../NOTICE
\ No newline at end of file
diff --git a/services/volcengine-tos/README.md b/services/volcengine-tos/README.md
new file mode 100644
index 0000000..d7be44a
--- /dev/null
+++ b/services/volcengine-tos/README.md
@@ -0,0 +1,29 @@
+# reqsign-volcengine-tos
+
+Volcengine Object Storage request signing implementation for reqsign.
+
+This crate supports both header authentication and presigned query
+authentication. Its default credential provider reads credentials from the
+environment.
+
+## Quick Start
+
+```rust,no_run
+use reqsign_core::{Context, OsEnv, Signer};
+use reqsign_volcengine_tos::{DefaultCredentialProvider, RequestSigner};
+
+let context = Context::new().with_env(OsEnv);
+let signer = Signer::new(
+ context,
+ DefaultCredentialProvider::new(),
+ RequestSigner::new("cn-beijing"),
+);
+```
+
+Set `VOLCENGINE_ACCESS_KEY_ID` and `VOLCENGINE_SECRET_ACCESS_KEY`, and
+optionally `VOLCENGINE_SESSION_TOKEN`. Use `StaticCredentialProvider` when the
+credentials are supplied directly by an application.
+
+## License
+
+Licensed under [Apache License, Version 2.0](./LICENSE).