aboutsummaryrefslogtreecommitdiff
path: root/ssh/agent/client.go
diff options
context:
space:
mode:
authorHan-Wen Nienhuys <hanwen@google.com>2016-02-25 15:07:55 +0100
committerAdam Langley <agl@golang.org>2016-02-26 16:32:03 +0000
commit5dc8cb4b8a8eb076cbb5a06bc3b8682c15bdbbd3 (patch)
treedffd72556fd30327bd4666a612a58c7c548ba64d /ssh/agent/client.go
parent1f22c0103821b9390939b6776727195525381532 (diff)
downloadgo-x-crypto-5dc8cb4b8a8eb076cbb5a06bc3b8682c15bdbbd3.tar.xz
x/crypto/ssh/agent: add a client example and tweak package doc.
Change-Id: I373fdbb6351d71b12fcfed31cf4b08975a443294 Reviewed-on: https://go-review.googlesource.com/19894 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Reviewed-by: Adam Langley <agl@golang.org> Run-TryBot: Adam Langley <agl@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
Diffstat (limited to 'ssh/agent/client.go')
-rw-r--r--ssh/agent/client.go13
1 files changed, 7 insertions, 6 deletions
diff --git a/ssh/agent/client.go b/ssh/agent/client.go
index 8c856a0..2cb9248 100644
--- a/ssh/agent/client.go
+++ b/ssh/agent/client.go
@@ -2,12 +2,13 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
-/*
- Package agent implements a client to an ssh-agent daemon.
-
-References:
- [PROTOCOL.agent]: http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.agent?rev=HEAD
-*/
+// Package agent implements the ssh-agent protocol, and provides both
+// a client and a server. The client can talk to a standard ssh-agent
+// that uses UNIX sockets, and one could implement an alternative
+// ssh-agent process using the sample server.
+//
+// References:
+// [PROTOCOL.agent]: http://cvsweb.openbsd.org/cgi-bin/cvsweb/src/usr.bin/ssh/PROTOCOL.agent?rev=HEAD
package agent // import "golang.org/x/crypto/ssh/agent"
import (