README
¶
torus-cli
A secure, shared workspace for secrets.
Homepage | Documentation | Twitter | Security Disclosure | Code of Conduct | Contribution Guidelines
Installation
Manifold provides binaries of torus-cli for OS X, Linux and Windows on amd64.
OS X
- homebrew:
brew install manifoldco/brew/torus - npm:
npm install -g torus-cli - bare zip archives per release version are available on https://get.torus.sh/
Linux
- RPM based distributions: Use the following repository configuration:
$ sudo tee /etc/yum.repos.d/torus.repo <<-'EOF'
[torus]
name=torus-cli repository
baseurl=https://get.torus.sh/rpm/$basearch/
enabled=1
gpgcheck=0
EOF
- DEB based distributions: Use the following repository configuration:
DISTRO=$(lsb_release -i | awk '{print tolower($3)}')
CODENAME=$(lsb_release -c | awk '{print $2}')
sudo tee /etc/apt/sources.list.d/torus.list <<< "deb https://get.torus.sh/$DISTRO/ $CODENAME main"
- npm:
npm install -g torus-cli - bare zip archives per release version are available on https://get.torus.sh/
Windows (Alpha)
Install torus via npm using npm install -g torus-cli or manally using the
steps below!
- Get the desired version on https://get.torus.sh/
- Unzip the file
- Put the
torus.exefile in your path- System Settings
- Advanced System Settings
- Advanced
- Environment Variables
- Edit Path in System Variables and add the full path to the folder where your
torus.exefile is
Security note
Currently on Windows, the Daemon will create a named pipe using the default security attributes. This means, that the LocalSystem account, administrators, and the creator will be granted full control. All members of the Everyone group and the anonymous account are granted read access.
More information can be found here.
Contributing
We're always looking for new contributors to help us improve Torus! To get started give our Contributor Guidelines a quick read!
Security Disclosure
Please follow our security disclosure document found here.
License
Manifold's torus-cli is released under the BSD 3-Clause License.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides the daemon API.
|
Package api provides the daemon API. |
|
Package cmd contains all of the Torus cli commands
|
Package cmd contains all of the Torus cli commands |
|
Package config exposes static configuration data, and loaded user preferences.
|
Package config exposes static configuration data, and loaded user preferences. |
|
crypto
Package crypto provides access to secure encryption and signing methods
|
Package crypto provides access to secure encryption and signing methods |
|
crypto/secure
Package secure is a wrapper package around memguard for managing data which must not be swapped to disk or easily read via a memory scanner.
|
Package secure is a wrapper package around memguard for managing data which must not be swapped to disk or easily read via a memory scanner. |
|
ctxutil
Package ctxutil contains utilities for using Contexts.
|
Package ctxutil contains utilities for using Contexts. |
|
db
Package db provides persistent storage and caching of values returned from the registry.
|
Package db provides persistent storage and caching of values returned from the registry. |
|
logic
Package logic exposes the core logic engine used for working with keyrings, keys, claims, teams, memberships, orgs, and other primitive objects core to the cryptography architecture
|
Package logic exposes the core logic engine used for working with keyrings, keys, claims, teams, memberships, orgs, and other primitive objects core to the cryptography architecture |
|
observer
Package observer provides a facility for publishing progress updates and state changes from parts of the daemon, an a SSE http handler for consumers of these events.
|
Package observer provides a facility for publishing progress updates and state changes from parts of the daemon, an a SSE http handler for consumers of these events. |
|
session
Package session provides in-memory storage of secure session details.
|
Package session provides in-memory storage of secure session details. |
|
Package dirprefs provides directory/project specific preference settings
|
Package dirprefs provides directory/project specific preference settings |
|
Package envelope defines the generic encapsulating format for torus objects.
|
Package envelope defines the generic encapsulating format for torus objects. |
|
Package gatekeeper is a web service that will listen for a machine identity from a Cloud provider, and request machine credentials.
|
Package gatekeeper is a web service that will listen for a machine identity from a Cloud provider, and request machine credentials. |
|
bootstrap
Package bootstrap provides authentication actions for the bootstrap process
|
Package bootstrap provides authentication actions for the bootstrap process |
|
client
Package client provides the Gatekeeper bootstrap API
|
Package client provides the Gatekeeper bootstrap API |
|
Package identity defines the ID format used for uniquely identifying objects in Torus.
|
Package identity defines the ID format used for uniquely identifying objects in Torus. |
|
Package pathexp provides a representation of path expressions; locations of secrets within the org/project/environment/service/identity/instance hierarchy supporting globs and alternation.
|
Package pathexp provides a representation of path expressions; locations of secrets within the org/project/environment/service/identity/instance hierarchy supporting globs and alternation. |
|
Package primitive contains definitions of the primitive types used in ag.
|
Package primitive contains definitions of the primitive types used in ag. |
|
Package prompts is a collection of functions for requesting information from the user such as their username, email, or whether or not they want to perform an action.
|
Package prompts is a collection of functions for requesting information from the user such as their username, email, or whether or not they want to perform an action. |
|
Package registry provides access to the Torus registry REST API.
|
Package registry provides access to the Torus registry REST API. |
|
tools
|
|
Click to show internal directories.
Click to hide internal directories.