alias to ssh-oidc, mention .bash_aliases
@@ -12,10 +12,16 @@ This can be done using the `-R` option of
Defining an alias makes this more easily usable:
. Example:
```
-alias ssh='ssh -R /tmp/oidc-forward-$RANDOM:$OIDC_SOCK'
+alias ssh-oidc='ssh -R /tmp/oidc-forward-$RANDOM:$OIDC_SOCK'
ssh user@host
```
-For most convenience, you should put the alias line into your `.profile`, or `.zshrc`.
+For most convenience, you should put the alias line into your `.profile`, `.zshrc`,
+or `.bash_aliases` file.
+
+**Note** that you could also overwrite the actual `ssh` command with an
+alias. While this works, this will always create a socket file on the
+remote host, which can be used by the remote system administrator to
+access your tokens. Use it wisely
### Server
@@ -28,7 +34,7 @@ Put the following in your `.profile`, `.zshrc`, or `.bash_profile` on the server
test -z $OIDC_SOCK && {
export OIDC_SOCK=`/bin/ls -rt /tmp/oidc-forward-* 2>/dev/null | tail -n 1`
}
-alias ssh='ssh -R /tmp/oidc-forward-$RANDOM:$OIDC_SOCK'
+alias ssh-oidc='ssh -R /tmp/oidc-forward-$RANDOM:$OIDC_SOCK'
```
Add this into your `.zlogout`, or `.bash_logout` on the server:
