summaryrefslogtreecommitdiffstats
path: root/vendor/der/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/der/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/der/README.md')
-rw-r--r--vendor/der/README.md96
1 files changed, 96 insertions, 0 deletions
diff --git a/vendor/der/README.md b/vendor/der/README.md
new file mode 100644
index 000000000..f7bb01560
--- /dev/null
+++ b/vendor/der/README.md
@@ -0,0 +1,96 @@
+# [RustCrypto]: ASN.1 DER
+
+[![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 embedded-friendly implementation of the Distinguished Encoding Rules (DER)
+for Abstract Syntax Notation One (ASN.1) as described in ITU X.690.
+
+[Documentation][docs-link]
+
+## About
+
+This crate provides a `no_std`-friendly implementation of a subset of ASN.1 DER
+necessary for decoding/encoding the following cryptography-related formats
+implemented as crates maintained by the [RustCrypto] project:
+
+- [`pkcs1`]: RSA Cryptography Specifications
+- [`pkcs5`]: Password-Based Cryptography Specification
+- [`pkcs7`]: Cryptographic Message Syntax
+- [`pkcs8`]: Private-Key Information Syntax Specification
+- [`pkcs10`]: Certification Request Syntax Specification
+- [`sec1`]: Elliptic Curve Cryptography
+- [`spki`]: X.509 Subject Public Key Info
+- [`x501`]: Directory Services Types
+- [`x509`]: Public Key Infrastructure Certificate
+
+The core implementation avoids any heap usage (with convenience methods
+that allocate gated under the off-by-default `alloc` feature).
+
+The DER decoder in this crate performs checks to ensure that the input document
+is in canonical form, and will return errors if non-canonical productions are
+encountered. There is currently no way to disable these checks.
+
+### Features
+
+- Rich support for ASN.1 types used by PKCS/PKIX documents
+- Performs DER canonicalization checks at decoding time
+- `no_std` friendly: supports "heapless" usage
+- Optionally supports `alloc` and `std` if desired
+- No hard dependencies! Self-contained implementation with optional
+ integrations with the following crates, all of which are `no_std` friendly:
+ - `const-oid`: const-friendly OID implementation
+ - `pem-rfc7468`: PKCS/PKIX-flavored PEM library with constant-time decoder/encoders
+ - `time` crate: date/time library
+
+## 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/der
+[crate-link]: https://crates.io/crates/der
+[docs-image]: https://docs.rs/der/badge.svg
+[docs-link]: https://docs.rs/der/
+[build-image]: https://github.com/RustCrypto/formats/actions/workflows/der.yml/badge.svg
+[build-link]: https://github.com/RustCrypto/formats/actions/workflows/der.yml
+[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
+
+[//]: # (links)
+
+[RustCrypto]: https://github.com/rustcrypto
+[`pkcs1`]: https://github.com/RustCrypto/formats/tree/master/pkcs1
+[`pkcs5`]: https://github.com/RustCrypto/formats/tree/master/pkcs5
+[`pkcs7`]: https://github.com/RustCrypto/formats/tree/master/pkcs7
+[`pkcs8`]: https://github.com/RustCrypto/formats/tree/master/pkcs8
+[`pkcs10`]: https://github.com/RustCrypto/formats/tree/master/pkcs10
+[`sec1`]: https://github.com/RustCrypto/formats/tree/master/sec1
+[`spki`]: https://github.com/RustCrypto/formats/tree/master/spki
+[`x501`]: https://github.com/RustCrypto/formats/tree/master/x501
+[`x509`]: https://github.com/RustCrypto/formats/tree/master/x509