3 This plugin starts automatically `ssh-agent` to set up and load whichever
4 credentials you want for ssh connections.
6 To enable it, add `ssh-agent` to your plugins:
9 plugins=(... ssh-agent)
14 **IMPORTANT: put these settings _before_ the line that sources oh-my-zsh**
16 ### `agent-forwarding`
18 To enable **agent forwarding support** add the following to your zshrc file:
21 zstyle :omz:plugins:ssh-agent agent-forwarding yes
26 To set an **external helper** to ask for the passwords and possibly store
27 them in the system keychain use the `helper` style. For example:
30 zstyle :omz:plugins:ssh-agent helper ksshaskpass
35 To **load multiple identities** use the `identities` style (**this has no effect
36 if the `lazy` setting is enabled**). For example:
39 zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github
42 **NOTE:** the identities may be an absolute path if they are somewhere other than
43 `~/.ssh`. For example:
46 zstyle :omz:plugins:ssh-agent identities ~/.config/ssh/id_rsa ~/.config/ssh/id_rsa2 ~/.config/ssh/id_github
47 # which can be simplified to
48 zstyle :omz:plugins:ssh-agent identities ~/.config/ssh/{id_rsa,id_rsa2,id_github}
53 To **NOT load any identities on start** use the `lazy` setting. This is particularly
54 useful when combined with the `AddKeysToAgent` setting (available since OpenSSH 7.2),
55 since it allows to enter the password only on first use. _NOTE: you can know your
56 OpenSSH version with `ssh -V`._
59 zstyle :omz:plugins:ssh-agent lazy yes
62 You can enable `AddKeysToAgent` by passing `-o AddKeysToAgent=yes` to the `ssh` command,
63 or by adding `AddKeysToAgent yes` to your `~/.ssh/config` file [1].
64 See the [OpenSSH 7.2 Release Notes](http://www.openssh.com/txt/release-7.2).
68 To **set the maximum lifetime of the identities**, use the `lifetime` style.
69 The lifetime may be specified in seconds or as described in sshd_config(5)
70 (see _TIME FORMATS_). If left unspecified, the default lifetime is forever.
73 zstyle :omz:plugins:ssh-agent lifetime 4h
78 To silence the plugin, use the following setting:
81 zstyle :omz:plugins:ssh-agent quiet yes
86 To **pass arguments to the `ssh-add` command** that adds the identities on startup,
87 use the `ssh-add-args` setting. You can pass multiple arguments separated by spaces:
90 zstyle :omz:plugins:ssh-agent ssh-add-args -K -c -a /run/user/1000/ssh-auth
93 These will then be passed the the `ssh-add` call as if written directly. The example
97 ssh-add -K -c -a /run/user/1000/ssh-auth <identities>
100 For valid `ssh-add` arguments run `ssh-add --help` or `man ssh-add`.
104 Based on code from Joseph M. Reagle: https://www.cygwin.com/ml/cygwin/2001-06/msg00537.html
106 Agent-forwarding support based on ideas from Florent Thoumie and Jonas Pfenniger