@mongodb-js/saslprep

What is @mongodb-js/saslprep?

The @mongodb-js/saslprep package is a Node.js implementation of the SASLprep algorithm, which is used for preparing strings for use in Simple Authentication and Security Layer (SASL) mechanisms, such as SCRAM (Salted Challenge Response Authentication Mechanism). It's particularly useful for sanitizing and normalizing user passwords before they are sent over the network for authentication purposes.

What are @mongodb-js/saslprep's main functionalities?

String preparation for SCRAM authentication

This feature allows you to prepare a string (typically a password) for use in SCRAM authentication by applying the SASLprep algorithm. It normalizes the string, which includes removing prohibited output, mapping input, and normalizing the string using Unicode normalization form KC (NFKC).

const saslprep = require('@mongodb-js/saslprep');
const prepared = saslprep('user\u00A0password');
console.log(prepared); // Outputs the prepared string, with non-ASCII space characters replaced, etc.

Other packages similar to @mongodb-js/saslprep

saslprep

This package provides similar functionality to @mongodb-js/saslprep. It implements the SASLprep algorithm for preparing strings for use in SASL mechanisms. The main difference is that it may be maintained by different authors or have slightly different API designs or dependencies.

stringprep

The stringprep package is an older implementation of the string preparation algorithms, including SASLprep. It is based on the now-deprecated node-stringprep package. Compared to @mongodb-js/saslprep, it may not be as up-to-date or maintained, and it might have more dependencies since it was built for older versions of Node.js.

README

saslprep

Note: This is a fork of the original saslprep npm package and provides equivalent functionality.

Stringprep Profile for User Names and Passwords, rfc4013

Usage

const saslprep = require('@mongodb-js/saslprep');

saslprep('password\u00AD'); // password
saslprep('password\u0007'); // Error: prohibited character

API

saslprep(input: String, opts: Options): String

Normalize user name or password.

Options.allowUnassigned: bool

A special behavior for unassigned code points, see https://tools.ietf.org/html/rfc4013#section-2.5. Disabled by default.

License

MIT, 2017-2019 (c) Dmitriy Tsvettsikh