Commit Graph

208 Commits

Author SHA1 Message Date
sarath 4e2856b1fa updated the command to run the examples tlsserver-mio and tlsclient-mio 2024-05-18 16:50:17 +00:00
Joseph Birr-Pixton ffcc718e23 README.md: fix spelling error 2024-05-01 11:56:22 +00:00
Daniel McCarney dd0b2cea29 proj: MSRV 1.61 -> 1.63
We're seeing more of our deps move to this MSRV or higher (e.g.
`webpki`, `rustls-platform-verifier`) and it's shipped in Debian stable.
Time to move our MSRV to 1.63.
2024-04-19 15:48:18 +00:00
Joseph Birr-Pixton 295cfdef46 Mention rustls-post-quantum in providers docs 2024-03-13 16:41:33 +00:00
Joseph Birr-Pixton 3f0e0fc66f Fix broken link to `CryptoProvider` 2024-02-19 11:05:47 +00:00
Joseph Birr-Pixton e2c5276cac Update manual::features and refer to it 2024-02-19 11:05:47 +00:00
Joseph Birr-Pixton 7415b5ff3d Change crate default provider to aws-lc-rs 2024-02-12 10:00:59 +00:00
Steve Fan 7e19ba171d docs: add rustls-rustcrypt to documented providers 2024-02-07 15:29:47 +00:00
elardus-erasmus ad1d015f11 Update README.md
Combine server and client authentication bullet points in the `Current functionality` list.
2024-01-23 09:56:14 +00:00
elardus-erasmus 93591ebe22 Update README.md - server auth
Correct the text per the original intent. Servers are authenticated by clients.
2024-01-23 09:56:14 +00:00
Daniel McCarney d9d0879432 docs: add more documentation on crypto providers
* Describe why crypto providers exist, how they are chosen
* Enumerate the built-in providers and associated feature flags
* Link to third-party providers we're aware of
* Add some documentation about implementing a custom provider
2024-01-18 15:18:26 +00:00
Daniel McCarney 0d4b2dfa52 docs: provide more pointers for examples
This commit provides more pointers to our existing examples and
additionally provides guidance about Rusts being low-level. Users that
just want to make an HTTPS request should probably use a crate built on
top of Rustls. Similarly, users in the Tokio ecosystem should look at
tokio-rustls.
2024-01-03 15:05:49 +00:00
Adolfo Ochagavía 93228ebdbf Add BENCHMARKING.md
This file is meant as an entry point for users and contributors who are
interested in benchmarking rustls. It is linked from the readme so
people can find it easily.

Closes #1478 and #1685
2023-12-20 16:13:01 +00:00
Joseph Birr-Pixton 0152242c3a Add roadmap
This is taken as a starting point from
<https://www.memorysafety.org/initiative/rustls/rustls-work-plan/>
2023-12-14 16:13:17 +00:00
Jacob Hoffman-Andrews 6845c013cb doc: remove `crate::` prefix for links
Instead, use `#[cfg(doc)]` to conditionally import names that we want to
use in the docs. This provides a user-friendlier link name.
2023-12-04 17:58:51 +00:00
Daniel McCarney d0aef3a11c docs: fix stale ref. to CryptProvider being a trait 2023-12-01 18:27:53 +00:00
Jacob Hoffman-Andrews 022042f17c doc: make it easier to find changelog
Many projects use CHANGELOG.md to convey their list of changes. Add a
link there. In README.md, instead of describing "release history",
use the "Changelog" terminology.
2023-12-01 08:40:16 +00:00
Daniel McCarney 90b20a2567 docs: update README project membership
* Leadership -> membership.
* Clarify roles per member.
* List full-time members and funding source.
* Add Josh Aas, project management.
* Link to GitHub profiles.
2023-11-30 17:10:43 +00:00
Joseph Birr-Pixton 1db4506dcf Update front page docs for crypto providers 2023-11-21 19:15:40 +00:00
Daniel McCarney ac10422a89 docs: adjust *ring* platform compatibility
Updated the README/lib.rs notes about *ring* platform compatibility to
fold in suggestions from Brian Smith.
2023-10-11 13:31:31 +00:00
Dirkjan Ochtman 8e64ed10b9 Upgrade to ring 0.17 2023-10-06 15:24:29 +00:00
Dirkjan Ochtman 2a94f9b2ab Bump MSRV to 1.61 2023-10-04 14:17:18 +00:00
Josh Aas 188e30481e docs: clarify self-signed certificate limitation
The self-signed certificate limitation imposed by the default webpki
certificate verifier is somewhat nuanced. This commit updates the README
to reflect some of this nuance.
2023-10-04 13:46:18 +00:00
Josh Aas a519303f0c Fix documentation error. 2023-09-15 16:36:52 +00:00
Josh Aas 10411018e9 Update text regarding production status. 2023-09-15 16:36:52 +00:00
Josh Aas 0b9e07847e Fix to stay within 90 character line limit 2023-09-15 16:36:52 +00:00
Josh Aas 274b285d15 Update the readme with the following changes:
- Don't list dependencies in the headline
- Remove relativistic language like "mature" and "widely"
- Remove possible future features as it is incomplete and thus misleading, should eventually replace with a roadmap
- Make it clear that Rustls provides no unsafe features *by default*
- remove self-signed certs and compression from non-features list because it's nuanced and we don't want to turn people away
- Add a list of project leadership
2023-09-15 16:36:52 +00:00
Dan Sover 9330cd746c docs: Add note on unsupported self-signed certificates
This clarifies the rustls position on self-signed certificates.
Users writing tests using rustls should be aware that a
self-signed cert won't work as expected.

Signed-off-by: Dan Sover <dan.sover@avalabs.org>
2023-08-15 18:05:32 +00:00
Tshepang Mbambo 79de94221f
readme: add some readability pauses (#1380)
See https://github.com/rustls/rustls/pull/1380#issuecomment-1660649621
2023-08-02 09:45:37 +02:00
Joseph Birr-Pixton ad62b2cf4a Update example usage in README.md
(with admin/pull-usage)
2023-07-27 08:34:49 +00:00
Joseph Birr-Pixton 9f76287912 Prepare to move release notes to github releases 2023-07-07 15:20:54 +01:00
Joseph Birr-Pixton 1d659a4689 Revert "Revert "Remove support for SCT stapling""
This reverts commit 777cc07a4b.
2023-07-07 15:20:54 +01:00
dAxpeDDa b3a0ce23f9 Take `IntoIterator` in `add_parsable_certificates()` 2023-07-06 12:17:11 +02:00
Daniel McCarney 27907af200 docs: update README changelog for 0.21.3.
Includes:

* CRL feature for the client verifiers.
* Certificate validation helpers when using `dangerous_configuration`
  feature.
2023-07-05 11:34:11 -04:00
Joseph Birr-Pixton 777cc07a4b Revert "Remove support for SCT stapling"
This reverts commit 4f0a7e0426.
2023-07-05 15:47:52 +01:00
Joseph Birr-Pixton 4f0a7e0426 Remove support for SCT stapling 2023-06-29 15:50:02 +01:00
dAxpeDDa 5053fde25b Prepare 0.21.2 2023-06-14 17:19:12 +02:00
Joseph Birr-Pixton 0ebeb0f056 Bump MSRV to 1.60
Log recently did this.
2023-06-12 09:50:56 +01:00
Joseph Birr-Pixton 975e1ca594 Prepare 0.21.1 2023-05-01 19:56:42 +01:00
Ofek Lev 0afab0f40f
docs: update webpki link (#1284) 2023-04-22 12:56:54 -04:00
Daniel McCarney ce933bb3c1 docs: replace dead Ring link from README.
Previously we linked to the *ring* README to describe Ring's supported
architectures in more detail. Unfortunately that section of the upstream
README was removed without a replacement.

This commit emphasizes that while Rustls is platform independent, *ring*
is not. To replace the detailed platform support information we now link
directly to the relevant *ring* CI configuration for the version in use
by Rustls.
2023-04-14 15:41:54 +02:00
Dennis Collinson a0501e492a Document 1.57 as min supported version in README 2023-03-30 06:40:54 +02:00
Daniel McCarney 0b380942ca
docs: remove future release notes. (#1265)
This commit removes two "Future release" items from the release history
section of the README.

It seems clearer to have this section dedicated to the release history,
not upcoming work. I also think the two described pieces of work might
not be what the project is currently prioritizing.
2023-03-29 14:22:55 -04:00
Daniel McCarney 13e4390906
docs: tidy README for 0.21.0 release. (#1264)
* docs: fix 0.21.0 description

* docs: move 0.20.x notes to RELEASE_NOTES.md
2023-03-29 13:57:16 -04:00
Dirkjan Ochtman 785675b8c7 Update note regarding stability 2023-03-29 18:32:10 +01:00
Dirkjan Ochtman d7be326b76 Update changelog in preparation for 0.21.0 2023-03-29 18:32:10 +01:00
Dirkjan Ochtman 282d009d9e Revert incorrect rename in changelog 2023-03-06 22:17:08 +01:00
ComplexSpaces fe94dec981 Improve error reporting for corrupt messages 2023-02-28 10:51:19 +01:00
Thales cd4f5c90ca
Harmonize certificate verifiers construction API (#1189)
* Harmonize certificate verifiers construction API

Signed-off-by: Thales Fragoso <thales.fragosoz@gmail.com>
2023-02-26 09:51:59 +01:00
Joseph Birr-Pixton 411a65d736 Changelog items for alpha1 2023-01-30 09:05:15 +00:00