Skip to content

An macOS menubar agent that listens for screen lock and sleep events and then communicates with ssh-agent to unload keys from memory.

License

Notifications You must be signed in to change notification settings

ktgeek/supreSSHion

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

supreSSHion

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

supreSSHion screenshot

History

Best practice is to unload your ssh keys from ssh-agent when you're not actively using them or not at your computer. The problem is no one remembers to do this themselves.

Long ago I used a tool called SSHKeyChain that filled in for ssh-agent before OS X had it well integrated. Besides asking you for your key when it was needed, it would remove the keys on certain events such as the screen locking.

SSHKeyChain fell out of support and then a friend of mine wrote a blog post and a user deamon called ssh_locker to fill in that gap. I used ssh_locker for a long time and made modifictions as times changed.

One issue is that bringing this to users who are new to ssh and/or aren't familiar with compiling on OS X and/or up to speed with putting LaunchAgents in their Library, etc, etc, was problematic. Additionally, there have been some situations where I've wanted to temporarily disable the key unloading, which was not easy to do with the background daemon version of ssh_locker. For these reasons a menu bar application seemed like a good fit.

After giving an internal talk on ssh at my company earlier in the year, I was inspired to finally turns this idea into reality.

How it works

When launched, supreSSHion registers itself as a listener for "screen is locked" and "workplace will sleep" events.

When it receives a lock event, it communicates to ssh-agent over its unix socket asking ssh-agent to unload all known keys. It locates the unix socket by the SSH_AUTH_SOCK environmental variable. macOS automatically creates that environmental variable when you log in.

If the key removal functionality is disabled lock events will not trigger key removal. When the screen is locked and the expiration time of the disable has been reached the keys will be removed.

When a sleep event is received, 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 loaded when ssh is invoked, ssh will prompt you for your key. (You may also want to specify your key using IdentityFile /path/to/id.)

This doesn't work in all cases where you might use ssh, but 99.99% of the time I'm invoking ssh from a terminal and it works very well for me.

License

supreSSHion is distributed under the MIT free software license, and freely available for inclusion in other projects.

Credits

App icon is Forget by Gregor Cresnar from the Noun Project. It is licensed under Creative Commons CCBY.

About

An macOS menubar agent that listens for screen lock and sleep events and then communicates with ssh-agent to unload keys from memory.

Resources

License

Stars

Watchers

Forks

Packages

No packages published