@verdaccio/utils

@verdaccio/utils - Verdaccio Utilities

Note: This package is mostly for internal use by Verdaccio and is only intended to be used with Verdaccio 6.x.

Overview

The @verdaccio/utils package provides common utility functions used across Verdaccio for authentication, cryptography, string manipulation, and package pattern matching.

Installation

npm install @verdaccio/utils

Usage

import {
  buildUserBuffer,
  createSessionToken,
  createTarballHash,
  generateRandomHexString,
  getAuthenticatedMessage,
  getMatchedPackagesSpec,
  stringToMD5,
} from '@verdaccio/utils';

API

Authentication Utilities

• createSessionToken() - Creates a session token with a 10-hour expiration
• getAuthenticatedMessage(user) - Returns an authentication success message
• buildUserBuffer(name, password) - Creates a Buffer from user credentials

Crypto Utilities

• stringToMD5(data) - Generates an MD5 hash from a string
• generateRandomHexString(length) - Generates a random hex string
• createTarballHash() - Creates a tarball hash object

Package Matching

• getMatchedPackagesSpec(pkgName, packages) - Matches a package name against configured access patterns

Donations

Verdaccio is run by volunteers; nobody is working full-time on it. If you find this project to be useful and would like to support its development, consider making a donation - your logo might end up in this readme.

Donate starting from $1/month or just one single contribution.

Report a vulnerability

If you want to report a security vulnerability, please follow the steps which we have defined for you in our security policy.

Open Collective Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Open Collective Backers

Thank you to all our backers! [Become a backer]

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

FAQ / Contact / Troubleshoot

If you have any issue you can try the following options. Do not hesitate to ask or check our issues database. Perhaps someone has asked already what you are looking for.

• Blog
• Donations
• Reporting an issue
• Running discussions
• Chat
• Logos
• Docker Examples
• FAQ

License

Verdaccio is MIT licensed

The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch files within the /assets folder) are Creative Commons licensed.