1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
|
package sshutil
import (
"bytes"
"net"
"runtime"
"time"
"github.com/pkg/errors"
"golang.org/x/crypto/ssh"
"golang.org/x/crypto/ssh/agent"
)
type options struct {
filterBySignatureKey func(*agent.Key) bool
removeExpiredKey func(*Agent, *agent.Key) bool
}
func newOptions(opts []AgentOption) *options {
o := new(options)
for _, fn := range opts {
fn(o)
}
return o
}
// AgentOption is the type used for variadic options in Agent methods.
type AgentOption func(o *options)
// WithSignatureKey filters certificate not signed by the given signing keys.
func WithSignatureKey(keys []ssh.PublicKey) AgentOption {
signingKeys := make([][]byte, len(keys))
for i, k := range keys {
signingKeys[i] = k.Marshal()
}
return func(o *options) {
o.filterBySignatureKey = func(k *agent.Key) bool {
cert, err := ParseCertificate(k.Marshal())
if err != nil {
return false
}
b := cert.SignatureKey.Marshal()
for _, sb := range signingKeys {
if bytes.Equal(b, sb) {
return true
}
}
return false
}
}
}
// WithRemoveExpiredCerts will remove the expired certificates automatically.
func WithRemoveExpiredCerts(t time.Time) AgentOption {
unixNow := t.Unix()
return func(o *options) {
o.removeExpiredKey = func(a *Agent, k *agent.Key) bool {
if cert, err := ParseCertificate(k.Marshal()); err == nil {
if before := int64(cert.ValidBefore); cert.ValidBefore != uint64(ssh.CertTimeInfinity) && (unixNow >= before || before < 0) {
if err := a.Remove(k); err == nil {
return true
}
}
}
return false
}
}
}
// ErrNotFound is the error returned if a something is not found.
var ErrNotFound = errors.New("not found")
// Agent represents a client to an ssh.Agent.
type Agent struct {
agent.ExtendedAgent
Conn net.Conn
}
// DialAgent returns an ssh.Agent client. It uses the SSH_AUTH_SOCK to connect
// to the agent.
func DialAgent() (*Agent, error) {
return dialAgent()
}
// Close closes the connection to the agent.
func (a *Agent) Close() error {
return a.Conn.Close()
}
// AuthMethod returns the ssh.Agent as an ssh.AuthMethod.
func (a *Agent) AuthMethod() ssh.AuthMethod {
return ssh.PublicKeysCallback(a.Signers)
}
// HasKeys returns if a key filtered with the given options exists.
func (a *Agent) HasKeys(opts ...AgentOption) (bool, error) {
o := newOptions(opts)
keys, err := a.List()
if err != nil {
return false, errors.Wrap(err, "error listing keys")
}
for _, key := range keys {
if o.removeExpiredKey != nil && o.removeExpiredKey(a, key) {
continue
}
if o.filterBySignatureKey == nil || o.filterBySignatureKey(key) {
return true, nil
}
}
return false, nil
}
// ListKeys returns the list of keys in the agent.
func (a *Agent) ListKeys(opts ...AgentOption) ([]*agent.Key, error) {
o := newOptions(opts)
keys, err := a.List()
if err != nil {
return nil, errors.Wrap(err, "error listing keys")
}
var list []*agent.Key
for _, key := range keys {
if o.removeExpiredKey != nil && o.removeExpiredKey(a, key) {
continue
}
if o.filterBySignatureKey == nil || o.filterBySignatureKey(key) {
list = append(list, key)
}
}
return list, nil
}
// ListCertificates returns the list of certificates in the agent.
func (a *Agent) ListCertificates(opts ...AgentOption) ([]*ssh.Certificate, error) {
keys, err := a.ListKeys(opts...)
if err != nil {
return nil, err
}
var list []*ssh.Certificate
for _, key := range keys {
if cert, err := ParseCertificate(key.Marshal()); err == nil {
list = append(list, cert)
}
}
return list, nil
}
// GetKey retrieves a key from the agent by the given comment.
func (a *Agent) GetKey(comment string, opts ...AgentOption) (*agent.Key, error) {
o := newOptions(opts)
keys, err := a.List()
if err != nil {
return nil, errors.Wrap(err, "error listing keys")
}
for _, key := range keys {
if key.Comment == comment {
if o.removeExpiredKey != nil && o.removeExpiredKey(a, key) {
continue
}
if o.filterBySignatureKey == nil || o.filterBySignatureKey(key) {
return key, nil
}
}
}
return nil, ErrNotFound
}
// GetSigner returns a signer that has a key with the given comment.
func (a *Agent) GetSigner(comment string, opts ...AgentOption) (ssh.Signer, error) {
key, err := a.GetKey(comment, opts...)
if err != nil {
return nil, err
}
signers, err := a.Signers()
if err != nil {
return nil, errors.Wrap(err, "error listing signers")
}
keyBytes := key.Marshal()
for _, sig := range signers {
if bytes.Equal(keyBytes, sig.PublicKey().Marshal()) {
return sig, nil
}
}
return nil, ErrNotFound
}
// RemoveKeys removes the keys with the given comment from the agent.
func (a *Agent) RemoveKeys(comment string, opts ...AgentOption) (bool, error) {
o := newOptions(opts)
keys, err := a.List()
if err != nil {
return false, errors.Wrap(err, "error listing keys")
}
var removed bool
for _, key := range keys {
if key.Comment == comment {
if o.filterBySignatureKey == nil || o.filterBySignatureKey(key) {
if err := a.Remove(key); err != nil {
return false, errors.Wrap(err, "error removing key")
}
removed = true
}
}
}
return removed, nil
}
// AddCertificate adds the given certificate to the agent.
func (a *Agent) AddCertificate(subject string, cert *ssh.Certificate, priv interface{}) error {
var (
lifetime uint64
now = uint64(time.Now().Unix())
)
if cert.ValidBefore == ssh.CertTimeInfinity {
// 0 indicates that the certificate should never expire from the agent.
lifetime = 0
} else if cert.ValidBefore <= now {
return errors.New("error adding certificate to ssh agent - certificate is already expired")
} else {
lifetime = cert.ValidBefore - now
}
// Windows SSH agent fails with a lifetime
if runtime.GOOS == "windows" {
lifetime = 0
}
return errors.Wrap(a.Add(agent.AddedKey{
PrivateKey: priv,
Certificate: cert,
Comment: subject,
LifetimeSecs: uint32(lifetime),
}), "error adding key to agent")
}
|