autho 0.0.4 → 0.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Readme.md +62 -63
- package/build/bin.js +59602 -0
- package/package.json +47 -19
- package/src/cli/bin.js +0 -126
- package/src/cli/utils.js +0 -15
- package/src/cli/wizards/createSecret.js +0 -106
- package/src/cli/wizards/getEncryptionKey.js +0 -30
- package/src/cli/wizards/getSecret.js +0 -31
- package/src/models/Secret.js +0 -12
- package/src/sdk/cipher.js +0 -70
- package/src/sdk/db.js +0 -23
- package/src/sdk/otp.js +0 -25
- package/src/sdk/secrets.js +0 -39
package/Readme.md
CHANGED
|
@@ -1,63 +1,62 @@
|
|
|
1
|
-
# Autho: Open Source Authentication and Password Management Tool
|
|
2
|
-
|
|
3
|
-
Autho is an open-source, self-hosted alternative to services like Authy, providing One-Time Password (OTP) generation and password management functionalities. With Autho, users can securely manage their authentication tokens and passwords while maintaining full control over their data.
|
|
4
|
-
|
|
5
|
-
## Features
|
|
6
|
-
|
|
7
|
-
- **OTP Generation**: Autho allows users to generate One-Time Passwords (OTPs) for two-factor authentication (2FA) using industry-standard algorithms.
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
Autho is built upon various open-source libraries and technologies. We extend our gratitude to the developers and contributors of these projects.
|
|
1
|
+
# Autho: Open Source Authentication and Password Management Tool
|
|
2
|
+
|
|
3
|
+
Autho is an open-source, self-hosted alternative to services like Authy, providing One-Time Password (OTP) generation and password management functionalities. With Autho, users can securely manage their authentication tokens and passwords while maintaining full control over their data.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **OTP Generation**: Autho allows users to generate One-Time Passwords (OTPs) for two-factor authentication (2FA) using industry-standard algorithms.
|
|
8
|
+
- **Password Management**: Autho provides a secure vault for users to store and manage their passwords, ensuring easy access and strong encryption.
|
|
9
|
+
|
|
10
|
+
- **Self-Hosted**: Autho can be self-hosted, giving users complete control over their data and eliminating reliance on third-party services.
|
|
11
|
+
|
|
12
|
+
- **Open Source**: Autho is open-source software, allowing users to inspect, modify, and contribute to its codebase, ensuring transparency and security.
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
To install Autho globally, use npm:
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
npm install -g autho
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
After installing Autho, you can run the `autho` command in your terminal to access its functionalities:
|
|
25
|
+
|
|
26
|
+
This will start the Autho CLI, where you can generate OTPs, manage passwords, and configure settings as needed.
|
|
27
|
+
|
|
28
|
+
## Getting Started
|
|
29
|
+
|
|
30
|
+
1. **Setting Up Autho**: After installation, run the `autho` command to set up Autho for the first time. Follow the on-screen instructions to configure your master password and other settings.
|
|
31
|
+
|
|
32
|
+
2. **Generating OTPs**: Use Autho to generate OTPs for your accounts by providing the associated account name or label. Autho will generate a time-based OTP using a secure algorithm.
|
|
33
|
+
|
|
34
|
+
3. **Managing Passwords**: Autho provides a secure vault for storing and managing your passwords. You can add, view, update, and delete passwords using the CLI interface.
|
|
35
|
+
|
|
36
|
+
4. **Self-Hosting**: If you prefer self-hosting, deploy Autho on your own server by following the instructions provided in the documentation.
|
|
37
|
+
|
|
38
|
+
## Security Considerations
|
|
39
|
+
|
|
40
|
+
- **Encryption**: Autho employs strong encryption algorithms to protect user data, ensuring that passwords and OTPs are securely stored.
|
|
41
|
+
|
|
42
|
+
- **Master Password**: Users are required to set a master password during setup, which is used to encrypt and decrypt their data. Choose a strong and unique master password to enhance security.
|
|
43
|
+
|
|
44
|
+
- **Self-Hosting**: By self-hosting Autho, users maintain control over their data and reduce reliance on external services, minimizing the risk of data breaches.
|
|
45
|
+
|
|
46
|
+
- **Regular Updates**: Keep Autho and its dependencies up to date to ensure that security vulnerabilities are addressed promptly.
|
|
47
|
+
|
|
48
|
+
## Contributing
|
|
49
|
+
|
|
50
|
+
Autho is an open-source project, and contributions are welcome! Feel free to report issues, suggest features, or submit pull requests on the project's GitHub repository.
|
|
51
|
+
|
|
52
|
+
## License
|
|
53
|
+
|
|
54
|
+
Autho is licensed under the [MIT License](link-to-license), allowing for unrestricted use, modification, and distribution.
|
|
55
|
+
|
|
56
|
+
## Support
|
|
57
|
+
|
|
58
|
+
For support or inquiries, please reach out to the [official Autho community](link-to-community) for assistance.
|
|
59
|
+
|
|
60
|
+
## Acknowledgments
|
|
61
|
+
|
|
62
|
+
Autho is built upon various open-source libraries and technologies. We extend our gratitude to the developers and contributors of these projects.
|