Skip to content

Commit

Permalink
update version and readme for initial release
Browse files Browse the repository at this point in the history
  • Loading branch information
ktgeek committed Apr 11, 2018
1 parent 8940886 commit e73ace8
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@

supreSSHion
===========

An OS X menubar agent that listens for screen lock and then
An OS X menubar agent that listens for screen lock and sleep and then
communicates with ssh-agent to unload keys from memory. It can also
temporarily disable this functionality as requested by the user.

Expand Down Expand Up @@ -41,14 +40,17 @@ the year, I was inspired to finally turns this into reality.
## How it works

When launched, supreSSHion registers itself as a listener listing for
"screen is locked" events. When it receives an event, it communicates
to ssh-agent over its unix socket using ssh-agent's protocol asking
ssh-agent to unload all known keys.
"screen is locked" and "workplace will sleep" events. When it receives
a lock event, it communicates to ssh-agent over its unix socket using
ssh-agent's protocol asking ssh-agent to unload all known keys.

It locates the unix socket by the SSH_AUTH_SOCK environmental
variable. OS X automatically creates that environmental variable when
you log in.

When a sleep event is recevied, it will reactivate the key removal if
the user had disabled the key unloading functionality.

### What about loading my SSH key?

You can add `AddKeysToAgent yes` to your ssh config. If your key isn't
Expand Down
2 changes: 1 addition & 1 deletion supreSSHion/Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<string>0.9</string>
<key>CFBundleVersion</key>
<string>1</string>
<key>LSApplicationCategoryType</key>
Expand Down

0 comments on commit e73ace8

Please sign in to comment.