@@ -23,11 +23,11 @@ virtual and controlled by a corporation, like accounts on _github.com_. Others
2323have a physical component as well, like a server in your closet, Raspberry Pi,
2424or laptop.
2525
26- All of these entities are part of your _ virtual estate_ and are often
27- intricately connected in various ways. As an example, you might have an SSH key
28- or API token on your machine that grants access to repositories (a kind of
29- digital asset) on Github. And suppose your machine also has an authorized key
30- installed that allows access from another machine:
26+ All of these entities are part of your _ virtual estate_ and are intricately
27+ connected in various ways. As an example, you might have an SSH key or API token
28+ on your machine that grants access to repositories (a kind of digital asset) on
29+ Github. And suppose your machine also has an authorized key installed that
30+ allows access from another machine:
3131
3232```
3333┌──────────┐ SSH Key ┌──────────┐ API Token ┌───────────────────┐
@@ -37,18 +37,18 @@ installed that allows access from another machine:
3737 └───────────────────┘
3838```
3939
40- If you care about those repos , then Sandpolis can map out an attack surface that
41- includes both ` Machine A ` and ` Machine B ` . If ` Machine A ` happens to have a weak
42- password or one that's shared with another website, then the attack surface is
43- consequently expanded with appropriate probabilities.
40+ If those private repos are worth protecting , then Sandpolis can map out an
41+ attack surface that includes both ` Machine A ` and ` Machine B ` . If ` Machine A `
42+ happens to have a weak password or one that's shared with another website, then
43+ the attack surface is consequently expanded with appropriate probabilities.
4444
4545Mapping these relationships automatically is possible because Sandpolis runs an
46- agent on ` Machine A ` and ` Machine B ` (and has API access to Github) .
46+ agent on ` Machine A ` and ` Machine B ` .
4747
4848## Security Warning
4949
5050Sandpolis is an extremely high-value attack target as it provides management
51- access to your virtual estate. To compensate, strong security measures are
51+ capabilities on your virtual estate. To compensate, strong security measures are
5252available:
5353
5454- All connections to a server use mTLS and require a valid client certificate.
@@ -87,7 +87,7 @@ Models online/offline accounts and their relationships to agent instances.
8787Enables higher-order analysis of virtual estate like attack surface mapping and
8888compromise tracing.
8989
90- ### Alert
90+ ### Audit
9191
9292Triggers user notifications when certain events are detected in the Sandpolis
9393network. For example, if a user's status is currently _ AWAY_ , an unexpected SSH
@@ -100,13 +100,11 @@ Provides access to remote desktop capabilities.
100100### Filesystem
101101
102102Provides read/write access to agent filesystems. The Sandpolis client can also
103- mount an agent's filesystem.
104-
105- ### Logging
103+ mount an agent's filesystem with FUSE.
106104
107105### Package
108106
109- Integrates with package managers to monitor package versions.
107+ Integrates with package managers to monitor software versions.
110108
111109### Probe
112110
@@ -119,11 +117,16 @@ the gateway instance remains online).
119117
120118### Shell
121119
122- Provides an interactive remote shell.
120+ Provides an interactive remote shell. Also stores customizable shell "snippets"
121+ that can be executed on a schedule.
123122
124123### Tunnel
125124
126- ### User
125+ Establishes a permanent or ephemeral TCP tunnel between arbitrary instances.
126+
127+ ### Snapshot
128+
129+ Create and apply _ cold snapshots_ via a boot agent.
127130
128131## Installation
129132
@@ -163,9 +166,9 @@ perform any excluded functionality.
163166``` yml
164167# Docker compose
165168services :
166- sandpolis-server:
167- image: sandpolis/server
168- restart: unless-stopped
169+ sandpolis-server :
170+ image : sandpolis/server
171+ restart : unless-stopped
169172` ` `
170173
171174#### Install client from DockerHub
0 commit comments