Rename aws-lc-rs (#101)

.github/ISSUE_TEMPLATE/build-issue.md

@@ -1,5 +1,5 @@
 ---
-name: AWS-LC-Rust Build Issue
+name: AWS-LC for Rust Build Issue
 about: Template
 title: ''
 labels: ''
@@ -12,7 +12,7 @@ assignees: ''
 A short description of the problem you are facing. Please include any build output, reproduction steps and environment(e.g. [Docker image](https://github.com/awslabs/aws-lc/blame/e7413d237bb60bf639e78aa43ff3c1b1783f0712/tests/ci/docker_images/linux-x86/ubuntu-20.04_base/Dockerfile)).
 
 #### Relevant details
-AWS-LC-Rust version or commit: (6b1bce0...)
+AWS-LC for Rust versions or commit: (6b1bce0...)
 
 System information: for linux, below info can be collected by running `uname -srvmp`
  * CPU architecture: (x86, x86-64, ARMv7...)

.github/ISSUE_TEMPLATE/general-issue.md

@@ -1,5 +1,5 @@
 ---
-name: AWS-LC-Rust General Issue
+name: AWS-LC for Rust General Issue
 about: Template
 title: ''
 labels: ''
@@ -9,7 +9,7 @@ assignees: ''
 
 ### Security issue notifications
 
-If you discover a potential security issue in AWS-LC-Rust we ask that you notify AWS Security via our
+If you discover a potential security issue in AWS-LC for Rust we ask that you notify AWS Security via our
 [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a
 public github issue, if in doubt contact AWS security first.
 
@@ -19,7 +19,7 @@ A short description of what the problem is and why we need to fix it. Add reprod
 
 ### Solution:
 
-A description of the possible solution in terms of AWS-LC-Rust architecture. Highlight and explain any potentially
+A description of the possible solution in terms of AWS-LC for Rust architecture. Highlight and explain any potentially
 controversial design decisions taken.
 
 * **Does this change any public APIs?** If yes, explain.

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        crate_dir: [ "aws-lc-sys", "aws-lc-fips-sys", "aws-lc-rust" ]
+        crate_dir: [ "aws-lc-sys", "aws-lc-fips-sys", "aws-lc-rs" ]
         features:
           - ""
           - "--features fips"
@@ -72,7 +72,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        crate_dir: [ "aws-lc-sys", "aws-lc-fips-sys", "aws-lc-rust" ]
+        crate_dir: [ "aws-lc-sys", "aws-lc-fips-sys", "aws-lc-rs" ]
         diff_target: [ "branch", "published" ]
     steps:
       - uses: actions/checkout@v3
@@ -195,8 +195,8 @@ jobs:
         env:
           RUSTC_WRAPPER: ""
 
-  aws-lc-rust-test:
-    name: aws-lc-rust tests
+  aws-lc-rs-test:
+    name: aws-lc-rs tests
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -237,17 +237,17 @@ jobs:
           args: cross
 
       - name: Run cargo test
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         if: ${{ matrix.target == 'native' }}
         run: cargo test ${{ matrix.args }} ${{ matrix.target != 'native' && format('--target {0}', matrix.target) || '' }}
 
       - name: Run cargo cross test
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         if: ${{ matrix.target != 'native' }}
         run: cross test ${{ matrix.args }} ${{ matrix.target != 'native' && format('--target {0}', matrix.target) || '' }}
 
   fips-test:
-    name: aws-lc-rust fips-tests
+    name: aws-lc-rs fips-tests
     runs-on: ${{ matrix.os }}
     env:
       CC: clang
@@ -274,11 +274,11 @@ jobs:
           toolchain: ${{ matrix.rust }}
           override: true
       - name: Run cargo test
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         run: cargo test ${{ matrix.args }}
 
-  aws-lc-rust-coverage:
-    name: aws-ls-rust coverage
+  aws-lc-rs-coverage:
+    name: aws-ls-rs coverage
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -303,7 +303,7 @@ jobs:
       # account. Using --html can give us more insight which regions are missing
       # coverage immediately.
       - name: Run coverage
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         run: cargo llvm-cov --no-fail-fast --fail-under-lines 95 --ignore-filename-regex "aws-lc-sys/*"
 
   mirai-analysis:
@@ -343,12 +343,12 @@ jobs:
           rm -rf ${MIRAI_TMP_SRC}
 
       - name: Run MIRAI
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         run: |
           cargo mirai
 
-  aws-lc-rust-asan:
-    name: aws-lc-rust asan
+  aws-lc-rs-asan:
+    name: aws-lc-rs asan
     strategy:
       matrix:
         args:
@@ -372,7 +372,7 @@ jobs:
           ASAN_OPTIONS: detect_leaks=1
           RUSTFLAGS: -Zsanitizer=address
           RUSTDOCFLAGS: -Zsanitizer=address
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         run: cargo test ${{ matrix.args }} --lib --bins --tests --examples --target x86_64-unknown-linux-gnu --features asan
 
   s2n-quic-integration:
@@ -392,7 +392,7 @@ jobs:
           toolchain: stable
           override: true
       - name: Run s2n-quic integration
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         run: |
           ./scripts/run-s2n-quic-integration.sh
 
@@ -413,6 +413,6 @@ jobs:
           toolchain: stable
           override: true
       - name: Run rustls integration
-        working-directory: ./aws-lc-rust
+        working-directory: ./aws-lc-rs
         run: |
           ./scripts/run-rustls-integration.sh

BUILDING.md

@@ -1,8 +1,8 @@
-# Building *aws-lc-rust*
+# Building *aws-lc-rs*
 
-Rust projects may add a dependency on *aws-lc-rust* using cargo.
+Rust projects may add a dependency on *aws-lc-rs* using cargo.
 See the [Cargo Book](https://doc.rust-lang.org/cargo/) for how to [specify dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html) in your project.
-See <https://crates.io/crates/aws-lc-rust> to find the latest version of our crate.
+See <https://crates.io/crates/aws-lc-rs> to find the latest version of our crate.
 
 # Requirements
 

Cargo.toml

@@ -1,6 +1,6 @@
 [workspace]
 members = [
-    "aws-lc-rust",
+    "aws-lc-rs",
     "aws-lc-sys",
     "aws-lc-fips-sys"
 ]

README.md

@@ -1,12 +1,12 @@
 # AWS Libcrypto for Rust
-[*aws-lc-rust*](aws-lc-rust/README.md) is a cryptographic library using [AWS-LC](https://github.com/aws/aws-lc) for its cryptographic operations.
+[*aws-lc-rs*](aws-lc-rs/README.md) is a cryptographic library using [AWS-LC](https://github.com/aws/aws-lc) for its cryptographic operations.
 This library strives to be API-compatible with the popular Rust library named 
 [ring](https://github.com/briansmith/ring). It uses either the auto-generated [*aws-lc-sys*](aws-lc-sys/README.md) or [*aws-lc-fips-sys*](aws-lc-fips-sys/README.md) Foreign Function Interface (FFI) crates found in this
 repository for invoking *AWS-LC*.
 
 ## Crates
 
-### [aws-lc-rust](aws-lc-rust/README.md)
+### [aws-lc-rs](aws-lc-rs/README.md)
 A *ring*-compatible crypto library using the cryptographic operations provided by
 [*AWS-LC*](https://github.com/awslabs/aws-lc) using either *aws-lc-sys* or *aws-lc-fips-sys*.
 
@@ -19,24 +19,24 @@ We do not recommend directly relying on these bindings.
 We do not recommend directly relying on these bindings. This crate uses [AWS-LC](https://github.com/aws/aws-lc/tree/fips-2022-11-02),
 which been submitted to an accredited lab for FIPS validation testing, and upon completion will be submitted to NIST
 for certification. Once NIST grants a validation certificate to AWS-LC, we will make an announcement to Rust developers
-on how to leverage the FIPS mode using [aws-lc-rust](https://crates.io/crates/aws-lc-rust).
+on how to leverage the FIPS mode using [aws-lc-rs](https://crates.io/crates/aws-lc-rs).
 
 # Motivation
 As there exists no standard Rust cryptographic API, we chose the Rust cryptographic library ring (v0.16) as our target API to 
 build higher-level Rust bindings on top of *AWS-LC*. *ring* is one of the most used cryptographic APIs in the Rust community,
 but lacked support for alternate cryptographic implementations. Our desire to build a Rust API on top of AWS-LC is to be able 
 to offer a FIPS validated Rust option for our customers. AWS-LC has been validated by an accredited lab,
-and was submitted to NIST on 2021-12-23. *aws-lc-rust* adds to the Rust cryptographic landscape with features such as an 
+and was submitted to NIST on 2021-12-23. *aws-lc-rs* adds to the Rust cryptographic landscape with features such as an 
 experimental FIPS operation mode, a stable API, and a process for
 [vulnerability reporting and disclosure](#security-notification-process).
 
 ## Questions, Feedback and Contributing
 
 * [Submit an non-security Bug/Issue/Request](https://github.com/awslabs/aws-lc-rust/issues/new/choose)
-* [API documentation](https://docs.rs/aws-lc-rust/)
+* [API documentation](https://docs.rs/aws-lc-rs/)
 * [Fork our repo](https://github.com/awslabs/aws-lc-rust/fork)
 
-If you have any questions about submitting PR's, opening issues, *aws-lc-rust* API usage or
+If you have any questions about submitting PR's, opening issues, *aws-lc-rs* API usage or
 any similar topic, we have a public chatroom available here to answer your questions
 on [Gitter](https://gitter.im/aws/aws-lc).
 
@@ -45,13 +45,13 @@ follow our *Security Notification Process* below.
 
 ## Security Notification Process
 
-If you discover a potential security issue in *AWS-LC* or *aws-lc-rust*, we ask that you notify AWS
+If you discover a potential security issue in *AWS-LC* or *aws-lc-rs*, we ask that you notify AWS
 Security via our
 [vulnerability reporting page](https://aws.amazon.com/security/vulnerability-reporting/).
 Please do **not** create a public GitHub issue.
 
-If you package or distribute *aws-lc-rust*, or use *aws-lc-rust* as part of a large multi-user service,
-you may be eligible for pre-notification of future *aws-lc-rust* releases.
+If you package or distribute *aws-lc-rs*, or use *aws-lc-rs* as part of a large multi-user service,
+you may be eligible for pre-notification of future *aws-lc-rs* releases.
 Please contact [email protected].
 
 ## License

STYLE.md

@@ -1,3 +1,3 @@
-# Style Guide for *aws-lc-rust*
+# Style Guide for *aws-lc-rs*
 
-This project follows the standard Rust Style Guidelines [documented here](https://github.com/rust-lang/fmt-rfcs/blob/master/guide/guide.md).
+This project follows the standard Rust Style Guidelines [documented here](https://github.com/rust-lang/fmt-rfcs/blob/master/guide/guide.md).

aws-lc-fips-sys/README.md

@@ -10,7 +10,7 @@
 This crate uses [AWS-LC](https://github.com/aws/aws-lc/tree/fips-2022-11-02), which been submitted to an accredited lab
 for FIPS validation testing, and upon completion will be submitted to NIST for certification. Once NIST grants a
 validation certificate to AWS-LC, we will make an announcement to Rust developers on how to leverage the FIPS mode
-using [aws-lc-rust](https://crates.io/crates/aws-lc-rust).
+using [aws-lc-rs](https://crates.io/crates/aws-lc-rs).
 
 ## Release Support
 

aws-lc-rust/Cargo.toml → aws-lc-rs/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "aws-lc-rust"
+name = "aws-lc-rs"
 authors = ["AWS-LibCrypto"]
 version = "1.0.0-rc1"
 edition = "2021"

aws-lc-rust/README.md → aws-lc-rs/README.md

@@ -1,6 +1,6 @@
-# AWS Libcrypto for Rust (aws-lc-rust)
+# AWS Libcrypto for Rust (aws-lc-rs)
 
-[![Crates.io](https://img.shields.io/crates/v/aws-lc-rust.svg)](https://crates.io/crates/aws-lc-rust)
+[![Crates.io](https://img.shields.io/crates/v/aws-lc-rs.svg)](https://crates.io/crates/aws-lc-rs)
 [![GitHub](https://img.shields.io/badge/GitHub-awslabs%2Faws--lc--rust-blue)](https://github.com/awslabs/aws-lc-rust)
 
 *ring*-compatible crypto library using the cryptographic operations provided by
@@ -20,7 +20,7 @@ Enable feature to preserve compatibility with ring's `signature::VerificationAlg
 function. This adds a requirement on `untrusted = "0.7.1"`.
 
 ##### - fips ####
-**EXPERIMENTAL** Enable this feature to have aws-lc-rust use the
+**EXPERIMENTAL** Enable this feature to have aws-lc-rs use the
 [*aws-lc-fips-sys*](https://crates.io/crates/aws-lc-fips-sys) crate for the cryptographic
 implementations. The *aws-lc-fips-sys* crate provides bindings to the FIPS variant of
 [*AWS-LC*](https://github.com/aws/aws-lc). AWS-LC has been submitted to an accredited lab
@@ -55,17 +55,17 @@ and performant Rust, built around our AWS-LC offering. We found the popular ring
 fulfilled much of the cryptographic needs in the Rust community, but it did not meet the needs
 of developers with FIPS requirements. Our intention is to contribute a drop-in replacement for
 ring that provides FIPS and is compatible with the ring API. Rust developers with prescribed
-cryptographic requirements can seamlessly integrate aws-lc-rust into their applications and
+cryptographic requirements can seamlessly integrate aws-lc-rs into their applications and
 deploy them into AWS Regions.
 
 
 ## Questions, Feedback and Contributing
 
 * [Submit an non-security Bug/Issue/Request](https://github.com/awslabs/aws-lc-rust/issues/new/choose)
-* [API documentation](https://docs.rs/aws-lc-rust/)
+* [API documentation](https://docs.rs/aws-lc-rs/)
 * [Fork our repo](https://github.com/awslabs/aws-lc-rust/fork)
 
-If you have any questions about submitting PR's, opening issues, *aws-lc-rust* API usage or
+If you have any questions about submitting PR's, opening issues, *aws-lc-rs* API usage or
 any similar topic, we have a public chatroom available here to answer your questions
 on [Gitter](https://gitter.im/aws/aws-lc).
 
@@ -74,13 +74,13 @@ follow our *Security Notification Process* below.
 
 ## Security Notification Process
 
-If you discover a potential security issue in *AWS-LC* or *aws-lc-rust*, we ask that you notify AWS
+If you discover a potential security issue in *AWS-LC* or *aws-lc-rs*, we ask that you notify AWS
 Security via our
 [vulnerability reporting page](https://aws.amazon.com/security/vulnerability-reporting/).
 Please do **not** create a public GitHub issue.
 
-If you package or distribute *aws-lc-rust*, or use *aws-lc-rust* as part of a large multi-user service,
-you may be eligible for pre-notification of future *aws-lc-rust* releases.
+If you package or distribute *aws-lc-rs*, or use *aws-lc-rs* as part of a large multi-user service,
+you may be eligible for pre-notification of future *aws-lc-rs* releases.
 Please contact [email protected].
 
 ## License

aws-lc-rust/README.tpl → aws-lc-rs/README.tpl

@@ -1,17 +1,17 @@
 # AWS Libcrypto for Rust ({{crate}})
 
-[![Crates.io](https://img.shields.io/crates/v/aws-lc-rust.svg)](https://crates.io/crates/aws-lc-rust)
+[![Crates.io](https://img.shields.io/crates/v/aws-lc-rs.svg)](https://crates.io/crates/aws-lc-rs)
 [![GitHub](https://img.shields.io/badge/GitHub-awslabs%2Faws--lc--rust-blue)](https://github.com/awslabs/aws-lc-rust)
 
 {{readme}}
 
 ## Questions, Feedback and Contributing
 
 * [Submit an non-security Bug/Issue/Request](https://github.com/awslabs/aws-lc-rust/issues/new/choose)
-* [API documentation](https://docs.rs/aws-lc-rust/)
+* [API documentation](https://docs.rs/aws-lc-rs/)
 * [Fork our repo](https://github.com/awslabs/aws-lc-rust/fork)
 
-If you have any questions about submitting PR's, opening issues, *aws-lc-rust* API usage or
+If you have any questions about submitting PR's, opening issues, *aws-lc-rs* API usage or
 any similar topic, we have a public chatroom available here to answer your questions
 on [Gitter](https://gitter.im/aws/aws-lc).
 
@@ -20,13 +20,13 @@ follow our *Security Notification Process* below.
 
 ## Security Notification Process
 
-If you discover a potential security issue in *AWS-LC* or *aws-lc-rust*, we ask that you notify AWS
+If you discover a potential security issue in *AWS-LC* or *aws-lc-rs*, we ask that you notify AWS
 Security via our
 [vulnerability reporting page](https://aws.amazon.com/security/vulnerability-reporting/).
 Please do **not** create a public GitHub issue.
 
-If you package or distribute *aws-lc-rust*, or use *aws-lc-rust* as part of a large multi-user service,
-you may be eligible for pre-notification of future *aws-lc-rust* releases.
+If you package or distribute *aws-lc-rs*, or use *aws-lc-rs* as part of a large multi-user service,
+you may be eligible for pre-notification of future *aws-lc-rs* releases.
 Please contact [email protected].
 
 ## License