Skip to content

Commit

Permalink
xsalsa20poly1305: deprecate in favor of crypto_secretbox (#525)
Browse files Browse the repository at this point in the history
The `crypto_secretbox` crate is forked from `xsalsa20poly1305`, but
modified and expanded to support the libsodium flavor of
XChaCha20Poly1305 in addition to XSalsa20Poly1305.

Further updates will happen on `crypto_secretbox`:

https://github.com/RustCrypto/nacl-compat/tree/master/crypto_secretbox
  • Loading branch information
tarcieri authored May 17, 2023
1 parent 2901c43 commit 277e330
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
5 changes: 1 addition & 4 deletions xsalsa20poly1305/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
[package]
name = "xsalsa20poly1305"
version = "0.9.0"
description = """
Pure Rust implementation of the XSalsa20Poly1305 (a.k.a. NaCl crypto_secretbox)
authenticated encryption algorithm
"""
description = "DEPRECATED: please use the `crypto_secretbox` crate"
authors = ["RustCrypto Developers"]
edition = "2021"
license = "Apache-2.0 OR MIT"
Expand Down
10 changes: 10 additions & 0 deletions xsalsa20poly1305/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@
[![Project Chat][chat-image]][chat-link]
[![Build Status][build-image]][build-link]

## 🚨 DEPRECATED! 🚨

Please switch to the [`crypto_secretbox`] crate.

This crate is deprecated and will not receive further updates.

## About

**XSalsa20Poly1305** (a.k.a. NaCl [`crypto_secretbox`][1]) is an
[authenticated encryption][2] cipher amenable to fast, constant-time
implementations in software, based on the [Salsa20][3] stream cipher
Expand Down Expand Up @@ -55,6 +63,8 @@ dual licensed as above, without any additional terms or conditions.

[//]: # (general links)

[`crypto_secretbox`]: https://github.com/RustCrypto/nacl-compat/tree/master/crypto_secretbox

[1]: https://nacl.cr.yp.to/secretbox.html
[2]: https://en.wikipedia.org/wiki/Authenticated_encryption
[3]: https://github.com/RustCrypto/stream-ciphers/tree/master/salsa20
Expand Down

0 comments on commit 277e330

Please sign in to comment.