Blame - ssh-add.1 - platform/external/openssh

blob: d37726e69e184d0dbd5417d02a4d8c13c2a121be [file] [log] [blame]

Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	1	.\" -- nroff --
				2	.\"
				3	.\" ssh-add.1
				4	.\"
				5	.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
				6	.\"
				7	.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
				8	.\" All rights reserved
				9	.\"
				10	.\" Created: Sat Apr 22 23:55:14 1995 ylo
				11	.\"
Damien Miller	22c7726	2000-04-13 12:26:34 +1000	[diff] [blame^]	12	.\" $Id: ssh-add.1,v 1.11 2000/04/13 02:26:37 damien Exp $
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	13	.\"
				14	.Dd September 25, 1999
				15	.Dt SSH-ADD 1
				16	.Os
				17	.Sh NAME
				18	.Nm ssh-add
				19	.Nd adds identities for the authentication agent
				20	.Sh SYNOPSIS
				21	.Nm ssh-add
Damien Miller	10f6f6b	1999-11-17 17:29:08 +1100	[diff] [blame]	22	.Op Fl lLdD
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	23	.Op Ar
Damien Miller	22c7726	2000-04-13 12:26:34 +1000	[diff] [blame^]	24	.Sh DESCRIPTION
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	25	.Nm
				26	adds identities to the authentication agent,
				27	.Xr ssh-agent 1 .
				28	When run without arguments, it adds the file
				29	.Pa $HOME/.ssh/identity .
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	30	Alternative file names can be given on the command line.
				31	If any file requires a passphrase,
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	32	.Nm
Damien Miller	22c7726	2000-04-13 12:26:34 +1000	[diff] [blame^]	33	asks for the passphrase from the user.
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	34	The Passphrase it is read from the user's tty.
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	35	.Pp
				36	The authentication agent must be running and must be an ancestor of
				37	the current process for
				38	.Nm
				39	to work.
				40	.Pp
				41	The options are as follows:
				42	.Bl -tag -width Ds
				43	.It Fl l
Damien Miller	10f6f6b	1999-11-17 17:29:08 +1100	[diff] [blame]	44	Lists fingerprints of all identities currently represented by the agent.
				45	.It Fl L
				46	Lists public key parameters of all identities currently represented by the agent.
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	47	.It Fl d
				48	Instead of adding the identity, removes the identity from the agent.
				49	.It Fl D
				50	Deletes all identities from the agent.
				51	.El
				52	.Sh FILES
				53	.Bl -tag -width Ds
Damien Miller	aae6c61	1999-12-06 11:47:28 +1100	[diff] [blame]	54	.It Pa $HOME/.ssh/identity
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	55	Contains the RSA authentication identity of the user.
				56	This file should not be readable by anyone but the user.
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	57	Note that
				58	.Nm
				59	ignores this file if it is accessible by others.
				60	It is possible to
				61	specify a passphrase when generating the key; that passphrase will be
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	62	used to encrypt the private part of this file.
				63	This is the default file added by
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	64	.Nm
				65	when no other files have been specified.
				66	.Pp
Damien Miller	aae6c61	1999-12-06 11:47:28 +1100	[diff] [blame]	67	.Sh ENVIRONMENT
				68	.Bl -tag -width Ds
				69	.It Ev "DISPLAY" and "SSH_ASKPASS"
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	70	If
				71	.Nm
				72	needs a passphrase, it will read the passphrase from the current
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	73	terminal if it was run from a terminal.
				74	If
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	75	.Nm
				76	does not have a terminal associated with it but
				77	.Ev DISPLAY
Damien Miller	5428f64	1999-11-25 11:54:57 +1100	[diff] [blame]	78	and
				79	.Ev SSH_ASKPASS
				80	are set, it will execute the program specified by
				81	.Ev SSH_ASKPASS
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	82	and open an X11 window to read the passphrase.
				83	This is particularly useful when calling
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	84	.Nm
				85	from a
				86	.Pa .Xsession
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	87	or related script.
				88	(Note that on some machines it
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	89	may be necessary to redirect the input from
				90	.Pa /dev/null
				91	to make this work.)
				92	.Sh AUTHOR
				93	Tatu Ylonen <ylo@cs.hut.fi>
				94	.Pp
				95	OpenSSH
				96	is a derivative of the original (free) ssh 1.2.12 release, but with bugs
Damien Miller	450a7a1	2000-03-26 13:04:51 +1000	[diff] [blame]	97	removed and newer features re-added.
				98	Rapidly after the 1.2.12 release,
				99	newer versions bore successively more restrictive licenses.
				100	This version of OpenSSH
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	101	.Bl -bullet
				102	.It
Damien Miller	1453785	2000-01-22 19:57:40 +1100	[diff] [blame]	103	has all components of a restrictive nature (i.e., patents, see
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	104	.Xr ssl 8 )
				105	directly removed from the source code; any licensed or patented components
				106	are chosen from
				107	external libraries.
				108	.It
				109	has been updated to support ssh protocol 1.5.
				110	.It
Damien Miller	22c7726	2000-04-13 12:26:34 +1000	[diff] [blame^]	111	contains added support for
Damien Miller	32aa144	1999-10-29 09:15:49 +1000	[diff] [blame]	112	.Xr kerberos 8
				113	authentication and ticket passing.
				114	.It
				115	supports one-time password authentication with
				116	.Xr skey 1 .
				117	.El
				118	.Pp
				119	The libraries described in
				120	.Xr ssl 8
				121	are required for proper operation.
				122	.Sh SEE ALSO
				123	.Xr ssh 1 ,
				124	.Xr ssh-agent 1 ,
				125	.Xr ssh-keygen 1 ,
				126	.Xr sshd 8 ,
				127	.Xr ssl 8