Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sniptt-official/ots
🔐 Share end-to-end encrypted secrets with others via a one-time URL
https://github.com/sniptt-official/ots
cli end-to-end-encryption secret-management secret-sharing
Last synced: 5 days ago
JSON representation
🔐 Share end-to-end encrypted secrets with others via a one-time URL
- Host: GitHub
- URL: https://github.com/sniptt-official/ots
- Owner: sniptt-official
- License: apache-2.0
- Created: 2021-07-15T18:13:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-25T11:39:40.000Z (almost 2 years ago)
- Last Synced: 2024-11-21T03:25:15.720Z (21 days ago)
- Topics: cli, end-to-end-encryption, secret-management, secret-sharing
- Language: Go
- Homepage: https://ots.sniptt.com
- Size: 104 KB
- Stars: 1,774
- Watchers: 20
- Forks: 47
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome - sniptt-official/ots - to-end-encryption,secret-management,secret-sharing pushed_at:2023-02 star:1.8k fork:0.0k 🔐 Share end-to-end encrypted secrets with others via a one-time URL (Go)
- awesome-cli-apps - ots - Share secrets with others via a one-time URL. (Utilities / Security)
- awesome-starred - sniptt-official/ots - 🔐 Share end-to-end encrypted secrets with others via a one-time URL (cli)
- fucking-awesome-cli-apps - ots - Share secrets with others via a one-time URL. (Utilities / Security)
README
Looking to self-host? Use the official CDK construct
If you use this repo, star it ✨
***
🔐 Share end-to-end encrypted secrets with others via a one-time URL
Use to securely share API Keys, Signing secrets, Passwords, etc. with 3rd parties or with your team
Secrets are destructed 💥 once viewed, or after specified expiry
***
Looking for the web version?
https://ots.sniptt.com
***
## Install
### Homebrew
The recommended way to install `ots` on macOS is via Homebrew.
```
brew install ots
```
### Go
```
go get -u github.com/sniptt-official/ots
```
## Usage
### Prompt
```
> ots new -x 2h
Enter your secret:
```
### Pipeline
You can also use pipes, for example
```
pbpaste | ots new
```
or
```
cat .env | ots new
```
### Data residency
Use `--region` to choose where the secrets reside.
```
ots new -x 24h --region eu-central-1
```
### Self-hosting
Please refer to [the official CDK construct](https://github.com/sniptt-official/ots-aws) for detailed instructions.
Grab your API Gateway URL, API key and configure `~/.ots.yaml` (or whatever you provide to `--config`):
```yaml
apiUrl: https://YOUR_API_ID.execute-api.YOUR_REGION.amazonaws.com/prod/secrets
apiKey: YOUR_API_KEY
```
Use `ots` as before:
```
> ots new -x 2h
Using config file: /Users/xxx/.ots.yaml
Enter your secret: ***
Your secret is now available on the below URL.
https://my-ots-web-view.com/burn-secret?id=xxx&ref=ots-cli®ion=us-east-1&v=debug#xxx
You should only share this URL with the intended recipient.
Please note that once retrieved, the secret will no longer
be available for viewing. If not viewed, the secret will
automatically expire at approximately xx xxx xxxx xx:xx:xx.
```
## FAQs
Please refer to our Q\&A discussions.
* [Why should I trust you with my secrets?](https://github.com/sniptt-official/ots/discussions/13)
* [Can I persist my secrets for later use?](https://github.com/sniptt-official/ots/discussions/15)
* [What kind of limits are in place?](https://github.com/sniptt-official/ots/discussions/18)
## License
See [LICENSE](LICENSE)