Skip to content

Commit

Permalink
docs: further doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
jo committed Mar 6, 2022
1 parent 97bc1c8 commit 194991f
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 8 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## v1.0.4 - Docs Improved II
Further improved documentation

## v1.0.3 - Docs Improved
More examples

Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "webcryptobox"
description = "Convenient wrappers around OpenSSL to use WebCrypto compatible cryptography."
version = "1.0.3"
version = "1.0.4"
edition = "2021"
documentation = "https://docs.rs/webcryptobox/latest/webcryptobox/"
homepage = "https://github.com/jo/webcryptobox-rs"
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Webcryptobox
Webcryptobox provides convenient wrappers around OpenSSL to use WebCrypto compatible cryptography.
Convenient wrappers around [OpenSSL](https://docs.rs/openssl/latest/openssl/) to use [WebCrypto](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) compatible cryptography.

It works nicely together with the [JavaScript Webcryptobox](https://github.com/jo/webcryptobox-js) and [Bash Webcryptobox](https://github.com/jo/webcryptobox-sh).

Webcryptobox provides functions for elliptic curve key generation, derivation, import and export as well as AES encryption and decryption.
Webcryptobox is **both a library and a little command line interface.** It helps with elliptic curve key generation, derivation, fingerprinting, import and export as well as AES encryption and decryption.

Webcryptobox comes with both a library and a little command line interface. For the library documentation, see [docs.rs/webcryptobox](https://docs.rs/webcryptobox/latest/webcryptobox/). In the following I describe the CLI usage.
For the library documentation, see [docs.rs/webcryptobox](https://docs.rs/webcryptobox/latest/webcryptobox/). In the following I describe the CLI usage.

## Installation
Clone the project, compile it and use the binary:
Expand Down
17 changes: 13 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
//! Webcryptobox provides convenient wrappers around OpenSSL to use WebCrypto compatible
#![warn(missing_docs)]
#![warn(rustdoc::missing_doc_code_examples)]

//! Webcryptobox provides convenient wrappers around
//! [OpenSSL](https://docs.rs/openssl/latest/openssl/) to use
//! [WebCrypto](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) compatible
//! cryptography.
//!
//! It works nicely together with the [JavaScript Webcryptobox](https://github.com/jo/webcryptobox-js).
//! It works nicely together with the [JavaScript
//! Webcryptobox](https://github.com/jo/webcryptobox-js) and [Bash
//! Webcryptobox](https://github.com/jo/webcryptobox-sh).
//!
//! Webcryptobox provides functions for elliptic curve key generation, derivation, import and
//! Webcryptobox helps with elliptic curve key generation, derivation, fingerprinting, import and
//! export as well as AES encryption and decryption.
use openssl::derive::Deriver;
Expand All @@ -16,9 +23,11 @@ use openssl::rand::rand_bytes;
use openssl::sha;
use openssl::symm;

// Length of the AEAD tag used in GCM mode
const AEAD_TAG_LENGTH: usize = 16;

/// Holds cipher configuration and provides the methods for dancing with elliptic curves and advanced encryption.
/// Holds cipher configuration and provides the methods for dancing with elliptic curves and
/// advanced encryption.
///
/// Use the factories [`webcryptobox::Webcryptobox::new`] or
/// [`webcryptobox::Webcryptobox::default`] to instantiate a Webcryptobox:
Expand Down

0 comments on commit 194991f

Please sign in to comment.