http-auth-basic

HTTP Basic Authentication Scheme (RFC 7617 base64-encoded credentials) for Rust applications


Keywords
auth, base64, basic, http, rust
License
GPL-3.0

Documentation

http-auth-basic

HTTP Basic Authentication Scheme (RFC 7617 base64-encoded credentials) for Rust applications

Crates.io Documentation Build Lint Tests

Description

The "Basic" Hypertext Transfer Protocol (HTTP) authentication scheme, transmits credentials as user-id/password pairs, encoded using Base64.

The server will gather the credentials from the base64 encoded header value, and will validate them to authenticate the user in question.

This crate covers the credentials encoding and decoding. The Credentials struct provides two fields user_id and password, these are filled with they raw values.

Installation

To install add the crate as follows to your dependencies list in your Cargo.toml.

[dependencies]
http-auth-basic = "0.1.1"

If you want to use a specific version, you must add the crate to your Cargo.toml as follows:

[dependencies]
http-auth-basic = { git = "https://github.com/EstebanBorai/http-auth-basic.git", tag = "v0.1.0" }

Usage

Decoding a basic authorization value and creating a Credentials struct from it

use http_auth_basic::Credentials;

let auth_header_value = String::from("Basic dXNlcm5hbWU6cGFzc3dvcmQ=");
let credentials = Credentials::from_header(auth_header_value).unwrap();

assert_eq!(credentials.user_id, String::from("username"));
assert_eq!(credentials.password, String::from("password"));

Encoding Credentials into a basic authorization header value.

use http_auth_basic::Credentials;

let credentials = Credentials::new("username", "password");
let credentials = credentials.as_http_header();

assert_eq!(String::from("Basic dXNlcm5hbWU6cGFzc3dvcmQ="), credentials);

Release

git tag -a v0.1.0 -m "Release Message"
git push origin main --follow-tags

Contributing

Every contribution to this project is welcome! Feel free to open a pull request or an issue.

References

License

Licensed under the GNU General Public License.