|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475 |
- # apache-crypt
- [Node.js](http://nodejs.org/) package for Apache style password encryption using crypt(3).
-
- [![build](https://github.com/http-auth/apache-crypt/workflows/build/badge.svg)](https://github.com/http-auth/apache-crypt/actions?query=workflow%3Abuild)
-
- ## Installation
-
- Via git (or downloaded tarball):
-
- ```bash
- $ git clone git://github.com/http-auth/apache-crypt.git
- ```
- Via [npm](http://npmjs.org/):
-
- ```bash
- $ npm install apache-crypt
- ```
-
- ## Usage
-
- ```javascript
- const crypt = require("apache-crypt");
-
- // Encrypting password using auto-generated 2 char salt.
- const encryptedPassword = crypt("mypass");
-
- // Should print true.
- console.log(crypt("mypass", encryptedPassword) == encryptedPassword);
- // Should print false.
- console.log(crypt("notmypass", encryptedPassword) == encryptedPassword);
- ```
-
- ## Running tests
-
- It uses [mocha](https://mochajs.org/), so just run following command in package directory:
-
- ```bash
- $ npm test
- ```
-
- ## Issues
-
- You can find list of issues using **[this link](http://github.com/http-auth/apache-crypt/issues)**.
-
- ## Requirements
-
- - **[Node.js](http://nodejs.org)** - Event-driven I/O server-side JavaScript environment based on V8.
- - **[npm](http://npmjs.org)** - Package manager. Installs, publishes and manages node programs.
-
- ## Dependencies
-
- - **[unix-crypt-td-js](https://github.com/TimDumol/unix-crypt-td-js/)** - Javascript implementation of the Unix crypt(3) DES-based hash.
-
- ## License
-
- The MIT License (MIT)
-
- Copyright (c) Gevorg Harutyunyan
-
- Permission is hereby granted, free of charge, to any person obtaining a copy of
- this software and associated documentation files (the "Software"), to deal in
- the Software without restriction, including without limitation the rights to
- use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
- the Software, and to permit persons to whom the Software is furnished to do so,
- subject to the following conditions:
-
- The above copyright notice and this permission notice shall be included in all
- copies or substantial portions of the Software.
-
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
- FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
- COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
- IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
- CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|