1# [RustCrypto]: PKCS#1 (RSA)
2
3[![crate][crate-image]][crate-link]
4[![Docs][docs-image]][docs-link]
5[![Build Status][build-image]][build-link]
6![Apache2/MIT licensed][license-image]
7![Rust Version][rustc-image]
8[![Project Chat][chat-image]][chat-link]
9
10Pure Rust implementation of Public-Key Cryptography Standards (PKCS) #1:
11RSA Cryptography Specifications Version 2.2 ([RFC 8017]).
12
13[Documentation][docs-link]
14
15## About
16
17This crate supports encoding and decoding RSA private and public keys
18in either PKCS#1 DER (binary) or PEM (text) formats.
19
20PEM encoded RSA private keys begin with:
21
22```text
23-----BEGIN RSA PRIVATE KEY-----
24```
25
26PEM encoded RSA public keys begin with:
27
28```text
29-----BEGIN RSA PUBLIC KEY-----
30```
31
32## Minimum Supported Rust Version
33
34This crate requires **Rust 1.65** at a minimum.
35
36We may change the MSRV in the future, but it will be accompanied by a minor
37version bump.
38
39## License
40
41Licensed under either of:
42
43 * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
44 * [MIT license](http://opensource.org/licenses/MIT)
45
46at your option.
47
48### Contribution
49
50Unless you explicitly state otherwise, any contribution intentionally submitted
51for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
52dual licensed as above, without any additional terms or conditions.
53
54[//]: # (badges)
55
56[crate-image]: https://buildstats.info/crate/pkcs1
57[crate-link]: https://crates.io/crates/pkcs1
58[docs-image]: https://docs.rs/pkcs1/badge.svg
59[docs-link]: https://docs.rs/pkcs1/
60[license-image]: https://img.shields.io/badge/license-Apache2.0/MIT-blue.svg
61[rustc-image]: https://img.shields.io/badge/rustc-1.65+-blue.svg
62[chat-image]: https://img.shields.io/badge/zulip-join_chat-blue.svg
63[chat-link]: https://rustcrypto.zulipchat.com/#narrow/stream/300570-formats
64[build-image]: https://github.com/RustCrypto/formats/workflows/pkcs1/badge.svg?branch=master&event=push
65[build-link]: https://github.com/RustCrypto/formats/actions
66
67[//]: # (links)
68
69[RustCrypto]: https://github.com/rustcrypto
70[RFC 8017]: https://datatracker.ietf.org/doc/html/rfc8017
71