summaryrefslogtreecommitdiffstats
path: root/vendor/pkcs8/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-04 12:41:41 +0000
commit10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87 (patch)
treebdffd5d80c26cf4a7a518281a204be1ace85b4c1 /vendor/pkcs8/README.md
parentReleasing progress-linux version 1.70.0+dfsg1-9~progress7.99u1. (diff)
downloadrustc-10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87.tar.xz
rustc-10ee2acdd26a7f1298c6f6d6b7af9b469fe29b87.zip
Merging upstream version 1.70.0+dfsg2.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'vendor/pkcs8/README.md')
-rw-r--r--vendor/pkcs8/README.md94
1 files changed, 94 insertions, 0 deletions
diff --git a/vendor/pkcs8/README.md b/vendor/pkcs8/README.md
new file mode 100644
index 000000000..2fa301ced
--- /dev/null
+++ b/vendor/pkcs8/README.md
@@ -0,0 +1,94 @@
+# [RustCrypto]: PKCS#8 (Private Keys)
+
+[![crate][crate-image]][crate-link]
+[![Docs][docs-image]][docs-link]
+[![Build Status][build-image]][build-link]
+![Apache2/MIT licensed][license-image]
+![Rust Version][rustc-image]
+[![Project Chat][chat-image]][chat-link]
+
+Pure Rust implementation of Public-Key Cryptography Standards (PKCS) #8:
+Private-Key Information Syntax Specification ([RFC 5208]).
+
+[Documentation][docs-link]
+
+## About PKCS#8
+
+PKCS#8 is a format for cryptographic private keys, often containing pairs
+of private and public keys.
+
+You can identify a PKCS#8 private key encoded as PEM (i.e. text) by the
+following:
+
+```text
+-----BEGIN PRIVATE KEY-----
+```
+
+PKCS#8 private keys can optionally be encrypted under a password using
+key derivation algorithms like PBKDF2 and [scrypt], and encrypted with
+ciphers like AES-CBC. When a PKCS#8 private key has been encrypted,
+it starts with the following:
+
+```text
+-----BEGIN ENCRYPTED PRIVATE KEY-----
+```
+
+PKCS#8 private keys can also be serialized in an ASN.1-based binary format.
+The PEM text encoding is a Base64 representation of this format.
+
+## Supported Algorithms
+
+This crate is implemented in an algorithm-agnostic manner with the goal of
+enabling PKCS#8 support for any algorithm.
+
+That said, it has been tested for interoperability against keys generated by
+OpenSSL for the following algorithms:
+
+- ECC (`id-ecPublicKey`)
+- Ed25519 (`id-Ed25519`)
+- RSA (`id-rsaEncryption`)
+- X25519 (`id-X25519`)
+
+Please open an issue if you encounter trouble using it with a particular
+algorithm, including the ones listed above or other algorithms.
+
+## Minimum Supported Rust Version
+
+This crate requires **Rust 1.57** at a minimum.
+
+We may change the MSRV in the future, but it will be accompanied by a minor
+version bump.
+
+## License
+
+Licensed under either of:
+
+ * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+ * [MIT license](http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
+[//]: # (badges)
+
+[crate-image]: https://buildstats.info/crate/pkcs8
+[crate-link]: https://crates.io/crates/pkcs8
+[docs-image]: https://docs.rs/pkcs8/badge.svg
+[docs-link]: https://docs.rs/pkcs8/
+[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
+[rustc-image]: https://img.shields.io/badge/rustc-1.57+-blue.svg
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
+[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/300570-formats
+[build-image]: https://github.com/RustCrypto/formats/workflows/pkcs8/badge.svg?branch=master&event=push
+[build-link]: https://github.com/RustCrypto/formats/actions
+
+[//]: # (links)
+
+[RustCrypto]: https://github.com/rustcrypto
+[RFC 5208]: https://tools.ietf.org/html/rfc5208
+[scrypt]: https://en.wikipedia.org/wiki/Scrypt