verdaccio-htpasswd
Advanced tools
Package description
The verdaccio-htpasswd package is a plugin for Verdaccio, a lightweight private npm proxy registry. This plugin allows you to manage user authentication using htpasswd files, which is a simple way to store usernames and passwords for HTTP authentication.
User Authentication
This feature allows you to authenticate users against an htpasswd file. The code sample demonstrates how to set up the htpasswd plugin and authenticate a user.
const Htpasswd = require('verdaccio-htpasswd');
const config = { file: './htpasswd', max_users: 1000 };
const htpasswd = new Htpasswd(config);
htpasswd.authenticate('username', 'password', (err, user) => {
if (err) {
console.error('Authentication failed:', err);
} else {
console.log('Authenticated user:', user);
}
});User Registration
This feature allows you to register new users by adding them to the htpasswd file. The code sample demonstrates how to add a new user.
const Htpasswd = require('verdaccio-htpasswd');
const config = { file: './htpasswd', max_users: 1000 };
const htpasswd = new Htpasswd(config);
htpasswd.adduser('newuser', 'newpassword', (err, user) => {
if (err) {
console.error('User registration failed:', err);
} else {
console.log('Registered user:', user);
}
});Password Management
This feature allows you to change the password of an existing user. The code sample demonstrates how to change a user's password.
const Htpasswd = require('verdaccio-htpasswd');
const config = { file: './htpasswd', max_users: 1000 };
const htpasswd = new Htpasswd(config);
htpasswd.changePassword('username', 'newpassword', (err) => {
if (err) {
console.error('Password change failed:', err);
} else {
console.log('Password changed successfully');
}
});The htpasswd package is a simple utility for managing htpasswd files. It provides basic functionalities like adding and deleting users, but it does not integrate directly with Verdaccio like verdaccio-htpasswd does.
The http-auth package provides HTTP Basic and Digest authentication for Node.js. While it offers more advanced authentication mechanisms, it does not specifically integrate with Verdaccio for npm registry authentication.
The express-basic-auth package is a simple middleware for basic authentication in Express.js applications. It is useful for protecting routes with basic auth but does not offer the same level of integration with Verdaccio as verdaccio-htpasswd.
Readme
verdaccio-htpasswd is a default authentication plugin for the Verdaccio.
Plugin only valid for verdaccio v5.x
As simple as running:
$ npm install -g verdaccio-htpasswd
auth:
htpasswd:
file: ./htpasswd
# Maximum amount of users allowed to register, defaults to "+infinity".
# You can set this to -1 to disable registration.
#max_users: 1000
# Hash algorithm, possible options are: "bcrypt", "md5", "sha1", "crypt".
# Default algorithm is crypt.
#algorithm: bcrypt
# Rounds number for "bcrypt", will be ignored for other algorithms.
# Setting this value higher will result in password verification taking longer.
#rounds: 10
# Log a warning if the password takes more then this duration in milliseconds to verify.
#slow_verify_ms: 200
It is important to note that when using the default bcrypt algorithm and setting
the rounds configuration value to a higher number then the default of 10, that
verification of a user password can cause significantly increased CPU usage and
additional latency in processing requests.
If your Verdaccio instance handles a large number of authenticated requests using
username and password for authentication, the rounds configuration value may need
to be decreased to prevent excessive CPU usage and request latency.
Also note that setting the rounds configuration value to a value that is too small
increases the risk of successful brute force attack. Auth0 has a
blog article
that provides an overview of how bcrypt hashing works and some best practices.
To log in using NPM, run:
npm adduser --registry https://your.registry.local
If you wish to handle access control using htpasswd file, you can generate username/password combination form here and add it to htpasswd file.
The htpasswd file contains rows corresponding to a pair of username and password
separated with a colon character. The password is encrypted using the UNIX system's
crypt method and may use MD5 or SHA1.
FAQs
htpasswd auth plugin for Verdaccio
The npm package verdaccio-htpasswd receives a total of 136,636 weekly downloads. As such, verdaccio-htpasswd popularity was classified as popular.
We found that verdaccio-htpasswd demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno's Standard Library has stabilized after four years of development, offering developers a collection of well-maintained tools compatible with Deno, Node.js, Cloudflare Workers, and browsers with bundlers.
Security News
Trivial packages, while convenient, can introduce significant risks such as dependency bloat, security vulnerabilities, and performance issues in modern software projects.
Security News
PyPI has drastically improved its malware response times, resolving 90% of issues in under 24 hours and removing 900 projects since March 2024.