Skip to content

Commit

Permalink
chore(README): update README; add copyright string (#708)
Browse files Browse the repository at this point in the history
  • Loading branch information
RitvikKapila authored Dec 6, 2024
1 parent 1628e66 commit c133d77
Show file tree
Hide file tree
Showing 9 changed files with 56 additions and 6 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/library_rust_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,13 @@ jobs:
' implementation_from_dafny.rs
fi
- name: Test Linter for Rust examples and implementation_from_dafny.rs
working-directory: ./AwsEncryptionSDK/runtimes/rust
shell: bash
run: |
cargo clippy
cargo clippy --example main
- name: Test Rust
working-directory: ./AwsEncryptionSDK
shell: bash
Expand Down
2 changes: 2 additions & 0 deletions AwsEncryptionSDK/runtimes/rust/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Changelog

2 changes: 2 additions & 0 deletions AwsEncryptionSDK/runtimes/rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ AWS Encryption SDK for Rust

The AWS Encryption SDK is available on [Crates.io](https://www.crates.io/).

For more details about the design and architecture of the AWS Encryption SDK, see the [AWS Encryption SDK Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).

## Building the AWS Encryption SDK for Rust

To build, the AWS Encryption SDK requires the most up to date version of [Dafny](https://github.com/dafny-lang/dafny) on your PATH.
Expand Down
5 changes: 5 additions & 0 deletions AwsEncryptionSDK/runtimes/rust/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

#![allow(warnings, unconditional_panic)]
#![allow(nonstandard_style)]
#![allow(clippy::never_loop)]
#![allow(clippy::absurd_extreme_comparisons)]

pub mod client;
pub mod conversions;
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

![Build Status - master branch](https://codebuild.us-west-2.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiVmIzeGwwQmY5bXdMQXg2aVBneWtDc3FHSWRHTjYrNnVUem9nNXJFUmY2Rk1yRnJvSjJvK3JCL2RScFRjSVF1UjA1elR3L0xpTVpiNmRZS0RyWjJpTnBFPSIsIml2UGFyYW1ldGVyU3BlYyI6InBBQm1tT1BPNjB3RU9XUS8iLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)

AWS Encryption SDK for Dafny
The AWS Encryption SDK enables secure client-side encryption. It uses cryptography best practices to protect your data and protect the encryption keys that protect your data. Each data object is protected with a unique data encryption key, and the data encryption key is protected with a key encryption key called a wrapping key. The encryption method returns a single, portable [encrypted message](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/message-format.html) that contains the encrypted data and the encrypted data key, so you don't need to keep track of the data encryption keys for your data. You can use KMS keys in [AWS Key Management Service](https://aws.amazon.com/kms/) (AWS KMS) as wrapping keys. The AWS Encryption SDK also provides APIs to define and use encryption keys from other key providers.

For more details about the design and architecture of the AWS Encryption SDK, see the [AWS Encryption SDK Developer Guide](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/introduction.html).

📣 Note: This repository contains the source code and related files for the
[supported language](#supported-languages) implementations of the AWS Encryption SDK.

[Security issue notifications](./CONTRIBUTING.md#security-issue-notifications)

Expand Down Expand Up @@ -86,6 +91,11 @@ To view the report, look at the generated `specification_compliance_report.html`
cargo +stable install duvet
```

## Supported Languages
- .NET
- Dafny
- Rust

## License

This library is licensed under the Apache 2.0 License.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Major Version Lifecycle
========================
The AWS Encryption SDK follows the same major version lifecycle as the AWS SDK. For details on this lifecycle, see `AWS SDKs and Tools Maintenance Policy`_.

Version Support Matrix
======================
This table describes the current support status of each major version of the AWS Encryption SDK for Java. It also shows the next status each major version will transition to, and the date at which that transition will happen.
Version Support Matrix for .NET
===============================
This table describes the current support status of each major version of the AWS Encryption SDK for .NET. It also shows the next status each major version will transition to, and the date at which that transition will happen.

.. list-table::
:widths: 30 50 50 50
Expand All @@ -30,5 +30,26 @@ This table describes the current support status of each major version of the AWS
-
-

.. _AWS SDKs and Tools Maintenance Policy: https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html#version-life-cycle

Version Support Matrix for Rust
===============================
This table describes the current support status of each major version of the AWS Encryption SDK for Rust. It also shows the next status each major version will transition to, and the date at which that transition will happen.

.. list-table::
:widths: 30 50 50 50
:header-rows: 1

* - Major version
- Current status
- Next status
- Next status date
* - 0.x
- Beta Version
- End of Support
- 2024-12-14
* - 4.x
- Generally Available
-
-

.. _AWS SDKs and Tools Maintenance Policy: https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html#version-life-cycle
3 changes: 3 additions & 0 deletions TestVectors/runtimes/rust/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

#![allow(warnings, unconditional_panic)]
#![allow(nonstandard_style)]

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion mpl
Submodule mpl updated from 370be9 to b5c352

0 comments on commit c133d77

Please sign in to comment.