Skip to content

Commit c133d77

Browse files
authored
chore(README): update README; add copyright string (#708)
1 parent 1628e66 commit c133d77

File tree

9 files changed

+56
-6
lines changed

9 files changed

+56
-6
lines changed

.github/workflows/library_rust_tests.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,13 @@ jobs:
125125
' implementation_from_dafny.rs
126126
fi
127127
128+
- name: Test Linter for Rust examples and implementation_from_dafny.rs
129+
working-directory: ./AwsEncryptionSDK/runtimes/rust
130+
shell: bash
131+
run: |
132+
cargo clippy
133+
cargo clippy --example main
134+
128135
- name: Test Rust
129136
working-directory: ./AwsEncryptionSDK
130137
shell: bash
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Changelog
2+

AwsEncryptionSDK/runtimes/rust/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ AWS Encryption SDK for Rust
66

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

9+
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).
10+
911
## Building the AWS Encryption SDK for Rust
1012

1113
To build, the AWS Encryption SDK requires the most up to date version of [Dafny](https://github.com/dafny-lang/dafny) on your PATH.

AwsEncryptionSDK/runtimes/rust/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1+
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
14
#![allow(warnings, unconditional_panic)]
25
#![allow(nonstandard_style)]
6+
#![allow(clippy::never_loop)]
7+
#![allow(clippy::absurd_extreme_comparisons)]
38

49
pub mod client;
510
pub mod conversions;

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,12 @@
22

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

5-
AWS Encryption SDK for Dafny
5+
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.
6+
7+
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).
8+
9+
📣 Note: This repository contains the source code and related files for the
10+
[supported language](#supported-languages) implementations of the AWS Encryption SDK.
611

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

@@ -86,6 +91,11 @@ To view the report, look at the generated `specification_compliance_report.html`
8691
cargo +stable install duvet
8792
```
8893

94+
## Supported Languages
95+
- .NET
96+
- Dafny
97+
- Rust
98+
8999
## License
90100

91101
This library is licensed under the Apache 2.0 License.

AwsEncryptionSDK/runtimes/net/SUPPORT_POLICY.rst renamed to SUPPORT_POLICY.rst

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Major Version Lifecycle
99
========================
1010
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`_.
1111

12-
Version Support Matrix
13-
======================
14-
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.
12+
Version Support Matrix for .NET
13+
===============================
14+
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.
1515

1616
.. list-table::
1717
:widths: 30 50 50 50
@@ -30,5 +30,26 @@ This table describes the current support status of each major version of the AWS
3030
-
3131
-
3232

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

34+
Version Support Matrix for Rust
35+
===============================
36+
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.
37+
38+
.. list-table::
39+
:widths: 30 50 50 50
40+
:header-rows: 1
41+
42+
* - Major version
43+
- Current status
44+
- Next status
45+
- Next status date
46+
* - 0.x
47+
- Beta Version
48+
- End of Support
49+
- 2024-12-14
50+
* - 4.x
51+
- Generally Available
52+
-
53+
-
54+
55+
.. _AWS SDKs and Tools Maintenance Policy: https://docs.aws.amazon.com/sdkref/latest/guide/maint-policy.html#version-life-cycle

TestVectors/runtimes/rust/src/main.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
2+
// SPDX-License-Identifier: Apache-2.0
3+
14
#![allow(warnings, unconditional_panic)]
25
#![allow(nonstandard_style)]
36

File renamed without changes.

mpl

Submodule mpl updated from 370be9c to b5c3522

0 commit comments

Comments
 (0)