@ricveal/basic-auth-utils

basic-auth-utils

Utils to work with Basic Authentication

---

The problem

I'm usually repeating code when I was working with Basic Authentication. This type of authentication uses Base64 encoding so it's very usual to extract credentials (username and password) given an authorization header or, given the credentials, build the header. This utility wants to extract this logic to reuse it across my different projects.

This solution

It's a simple set of utility functions that:

• process your request headers and return an object with the username and the password or an Error if:

  • The authorization (or Authorization) header is not given.
  • Its format is not correct.

• given a username and password, returns a Basic header.

Table of Contents

• Installation
• Usage
• Other Solutions
• Issues
  • 🐛 Bugs
  • 💡 Feature Requests
• Contributors ✨
• LICENSE

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies:

npm install --save @ricveal/basic-auth-utils

Usage

Once it's installed as dependency, you only have to import it and use the util you prefer:

import {
  getUsernameAndPasswordFromAuthBasic,
  getAuthBasicFromUsernameAndPassword,
} from '@ricveal/basic-auth-utils'

const headers = {
  authorization: 'Basic dXNlcjp0ZXN0',
}
const {username, password} = getUsernameAndPasswordFromAuthBasic(headers)
console.log(username, password) // 'user', 'test'

console.log(getAuthBasicFromUsernameAndPassword('user', 'test')) // 'Basic dXNlcjp0ZXN0'

Other Solutions

I'm not aware of any, if you are please make a pull request and add it here!

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

Contributors ✨

Contributions of any kind welcome!

LICENSE

MIT