Editing SSH:Authorized Keys

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 5: Line 5:
<h3>Decisions to make</h3>
<h3>Decisions to make</h3>


<h4>Passphrase or not?</h4>  
<h4>Passphrase or not?</h4> If you use a passphrase, the key will not
  be useable unless you type the passphrase to make it available. 
<p> So this is not helpful if you want ssh to run unattended for some
  reason.
<p> On the other hand, it means that someone with temporary access to your
  account can't just make a copy of the private key file and then use
  it subsequently
<h4>key type?</h4> Unless you have good reason to do otherwise, allow
  the key generator to use its default (rsa for ssh-v2 connections).


If you use a passphrase, the key will not be usable unless you type the passphrase to make it available. 
<h3>Creating the key</h3>


So this is not helpful if you want ssh to run unattended for some reason.
  You can create a private/public key pair (in the files
 
  <code>~/.ssh/filename</code> and <code>~/.ssh/filename.pub</code>)
On the other hand, it means that someone with temporary access to your account can't just make a copy of the private key file and then use it subsequently
  that has no passphrase protecting the private key, by doing the
 
  following:
<h4>key type?</h4>
 
Unless you have good reason to do otherwise, allow the key generator to use its default (rsa for ssh-v2 connections).<h3>Creating the key</h3>You can create a private/public key pair (in the files <code>~/.ssh/filename</code> and <code>~/.ssh/filename.pub</code>) that has no passphrase protecting the private key, by doing the following:


<pre>
<pre>
Line 22: Line 27:
</pre>
</pre>


The two files created (<code>filename</code> and <code>filename.pub</code>) can then be used as described below.
  The two files created (<code>filename</code> and <code>filename.pub</code>)
 
  can then be used as described below.
If on the other hand, you'd like to protect the private key file with a passphrase (which will be needed to be typed at any client that wants to use the key pair):
<p> 
  If on the other hand, you'd like to protect the private key file with
  a passphrase (which will be needed to be typed at any client that wants
  to use the key pair):


<pre>
<pre>
Line 31: Line 39:
</pre>
</pre>


and you'll be prompted for a passphrase.  This has no limitation on length.  All the normal advice about non-guessable passwords may reasonably be applied to it, although it's possible that a suitably long passphrase consisting of dictionary-attackable words can be just as secure as a short passphrase of random characters.<h3>What the private/public key files are for</h3>The private key is the secret one, not surprisingly.  It needs to be kept secure (not world-readable).  Only a client with knowledge of the private key can correctly respond to a challenge issued by a server that is using the public key.
  and you'll be prompted for a passphrase.  This has no limitation on
  length.  All the normal advice about non-guessable passwords may  
  reasonably be applied to it, although it's possible that a suitably
  long passphrase consisting of dictionary-attackable words can be just
  as secure as a short passphrase of random characters.


If the private key is not passphrase protected, then the file containing it is particularly sensitive; even temporary exposure of your account to a third party could allow it to be copied and then used inappropriately.
<h3>What the private/public key files are for</h3>


If the private key is passphrase protected, then its vulnerability is lower;  an attacker would need a copy of the private key file, and <em>also</em> to observe your keystrokes typing the passphrase to your client program (or to have inserted a trojan version of the client program, or ...).
  The private key is the secret one, not surprisingly.  It needs to
  be kept secure (not world-readable).  Only a client with knowledge
  of the private key can correctly respond to a challenge issued
  by a server that is using the public key.
  <p>
  If the private key is not passphrase protected, then the file
  containing it is particularly sensitive; even temporary exposure of
  your account to a third party could allow it to be copied and then
  used inappropriately.
  <p>
  If the private key is passphrase protected, then its vulnerability is
  lower;  an attacker would need a copy of the private key file, and
  <em>also</em> to observe your keystrokes typing the passphrase to
  your client program (or to have inserted a trojan version of the
  client program, or ...).


The public key does not need to be kept secret; there is no practical way of guessing the private key that will match it.  It is put in your <code>~/.ssh/authorized_keys</code> file on the machine that you want to connect to.   
  The public key does not need to be kept secret; there is no
 
  practical way of guessing the private key that will match it.  It
There may be good reasons to keep the <code>authorized_keys</code> file protected from world-readability (it may contain directives as to what machines may use a given key or what commands will be run in response to the use of a given key, which may be sensitive information) but protecting the public key is not one of them!
  is put in your <code>~/.ssh/authorized_keys</code> file on the
  machine that you want to connect to.   
<p>
  There may be good reasons to keep the <code>authorized_keys</code>
  file protected from world-readability (it may contain directives as
  to what machines may use a given key or what commands will be run
  in response to the use of a given key, which may be sensitive
  information) but protecting the public key is not one of them!
    
    


=== Setting up an authorized_keys file ===
<h3>Setting up an authorized_keys file</h3>


Once you've created your key pair, you can insert the public half of it into your authorized_keys file on computer "X".  A client on computer "Y" that knows the private key can then authenticate to your account on computer "X".
  Once you've created your key pair, you can insert the public half
 
  of it into your authorized_keys file on computer "X".  A client on
So, on the machine you want to log into, you should add a line to your <code>~/.ssh/authorized_keys</code> file that contains exactly the single line that was created in the <code>filename.pub</code> file (for whatever choice of "filename" you made).
  computer "Y" that knows the private key can then authenticate to
 
  your account on computer "X".
For example, we might wind up with a <code>.ssh/authorized_keys</code> file that looks like:
<p>
  So, on the machine you want to log into, you should add a line to
  your <code>~/.ssh/authorized_keys</code> file that contains exactly
  the single line that was created in the <code>filename.pub</code>
  file (for whatever choice of "filename" you made).
<p>
  For example, we might wind up with a <code>.ssh/authorized_keys</code>
  file that looks like:
<pre>
<pre>
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAybmcqaU/Xos/GhYCzkV+kDsK8+A5OjaK
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAybmcqaU/Xos/GhYCzkV+kDsK8+A5OjaK
Line 58: Line 98:
key
key
</pre>
</pre>
 
  except that I have deliberately split the single long line to make  
except that I have deliberately split the single long line to make it more readable.
it more readable.


<h3>Making an ssh connection using a private key</h3>
<h3>Making an ssh connection using a private key</h3>
 
<p> 
On the machine you want to log in <em>from</em> you would run
  On the machine you want to log in <em>from</em> you would run
 
<pre>
<pre>
   slogin -i ~/.ssh/filename remotehost
   slogin -i ~/.ssh/filename remotehost
</pre>
</pre><p>
 
  (for appropriate values of "filename" and "remotehost") thus
(for appropriate values of "filename" and "remotehost") thus telling slogin to look in the private key file.
  telling slogin to look in the private key file.
 
<p>
The connection would then be made without any further authentication being necessary (although <code>slogin</code> would prompt for a passphrase if the private key were protected by one.
  The connection would then be made without any further authentication
 
  being necessary (although <code>slogin</code> would prompt for a  
<h3>authorized_keys: restricting access</h3>
  passphrase if the private key were protected by one.
 
</p>
What we have described above allows any remote host where the private key is known to make any kind of ssh connection (login, remote command execution, port forwarding, etc.) to the computer on which the <code>authorized_keys</code>. There are a number of things that can be done in an authorized_keys to further restrict access.  These are all arranged by prefixing the line containing the public key by a single "phrase" of comma-separated options (see below for an example of what this winds up looking like)
<h3>authorized_keys : restricting access</h3>
 
<p>
  What we have described above allows any remote host where the private
  key is known to make any kind of ssh connection (login, remote command
  execution, port forwarding, etc.) to the computer on which the
  <code>authorized_keys</code.>
  There are a number of things that can be done in an authorized_keys to
  further restrict access.  These are all arranged by prefixing the
  line containing the public key by a single "phrase" of comma-separated  
  options (see below for an example of what this winds up looking like)
</p>
<h4>Host access list</h4>
<h4>Host access list</h4>
 
<p>
If the options phrase at the beginning of a line contains the keyword <code>from="string"</code> this restricts the use of the key on that line to sessions that originate from hosts that match <code>"string"</code>. Examples might be
  If the options phrase at the beginning of a line contains the
 
  keyword <code>from="string"</code> this restricts the use of the
<pre>
  key on that line to sessions that originate from hosts that match
  <code>"string"</code>. Examples might be
</p><pre>
   from="trusted.eng.cam.ac.uk"
   from="trusted.eng.cam.ac.uk"
   from="*.eng.cam.ac.uk,!untrusted.eng.cam.ac.uk"
   from="*.eng.cam.ac.uk,!untrusted.eng.cam.ac.uk"
   from="tw?00.eng.cam.ac.uk"
   from="tw?00.eng.cam.ac.uk"
</pre>
</pre><p>
 
  The hostname used will need to be the hostname reported when the IP
The hostname used will need to be the hostname reported when the IP (network) address of the connecting machine is looked up in the DNS. The <code>*</code> wildcard matches one or more characters, while the <code>?</code> wildcard matches a single character.  If the connecting hostname matches an entry prefixed by '!', then it will be rejected.
  (network) address of the connecting machine is looked up in the DNS.
 
  The <code>*</code> wildcard matches one or more characters, while the
  <code>?</code> wildcard matches a single character.  If the connecting
  hostname matches an entry prefixed by '!', then it will be rejected.
</p>
<h4>Forced command</h4>
<h4>Forced command</h4>
 
<p>
If the options phrase at the beginning of a line contains the keyword <code>command="string"</code>, then any ssh connection that authenticates using that particular key will <em>only</em> run the command specified, even if the command line it was given specified another command.
  If the options phrase at the beginning of a line contains the keyword
 
  <code>command="string"</code>, then any ssh connection that authenticates
  using that particular key will <em>only</em> run the command specified,
  even if the command line it was given specified another command.
</p>
<h4>Other options</h4>
<h4>Other options</h4>
 
<p>
Various ssh facilities may be suppressed by adding the following options to the options phrase at the beginning of a line:
  Various ssh facilities may be suppressed by adding the following options
 
  to the options phrase at the beginning of a line:
</p>
<pre>
<pre>
   no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty
   no-port-forwarding,no-X11-forwarding,no-agent-forwarding,no-pty
</pre>
</pre><p> 
 
  When heavily restricting an ssh key in circumstances where entirely
When heavily restricting an ssh key in circumstances where entirely automated remote connections are desired, it is generally a good idea to apply all of these options unless the command being run actually needs one of these facilities.
  automated remote connections are desired, it is generally a good idea
 
  to apply all of these options unless the command being run actually
  needs one of these facilities.
</p>
<h4>Example authorized_keys file</h4>
<h4>Example authorized_keys file</h4>
 
<p>
This example file has two entries.  Note that there is no whitespace in the list of options; they are separated by commas, and strings are double-quoted (eg in the argument to <code>from=</code>).
This example file has two entries.  Note that there is no whitespace
 
in the list of options; they are separated by commas, and strings are
double-quoted (eg in the argument to <code>from=</code>).
</p>
<pre>
<pre>
#
#
Line 129: Line 190:
4c/ieETOXE5L+fVrbtOh7DTFMjIYAWNxy4tlMR/59UVw5dapAxH9J2lZglkj0w0LwFI
4c/ieETOXE5L+fVrbtOh7DTFMjIYAWNxy4tlMR/59UVw5dapAxH9J2lZglkj0w0LwFI
+7hZu9XvNfMKMKg+ERAz9XHYH3608RL1RQ== This comment describes key #2
+7hZu9XvNfMKMKg+ERAz9XHYH3608RL1RQ== This comment describes key #2
</pre>
</pre><p>
 
Note that in reality, such a file would only have two uncommented
Note that in reality, such a file would only have two uncommented lines, both of them very long.
lines, both of them very long.
 
</p>
<h3>If it doesn't work</h3>
<h3>If it doesn't work</h3>
 
<p>
There are a number of reasons why key authentication might not work.
There are a number of reasons why key authentication might not work.
 
</p>
<h4>Wrong keys</h4>
<h4>Wrong keys</h4>
 
<p>First, check that you really have put the matching public key in
First, check that you really have put the matching public key in the <code>~/.ssh/authorized_keys</code> file on the machine you're trying to connect <em>to</em>, and that you're telling your ssh client about the correct private key using the <code>-i</code> argument.
the <code>~/.ssh/authorized_keys</code> file on the machine you're
 
trying to connect <em>to</em>, and that you're telling your ssh
client about the correct private key using the <code>-i</code>
argument.
</p>
<h4>Keys the wrong way round</h4>
<h4>Keys the wrong way round</h4>
 
<p>
The public key goes in the destination host's <code>~/.ssh/authorized_keys</code> file.
The public key goes in the destination host's
 
<code>~/.ssh/authorized_keys</code> file.
<p>
The private key is needed on the machine you're running ssh or slogin from.
The private key is needed on the machine you're running ssh or slogin from.
 
</p>
<h4>File permissions</h4>
<h4>File permissions</h4>
Some clients and servers are very picky about file permissions on their configuration files.  Among possible objections they may have are:
<p>Some clients and servers are very picky about file permissions on their
configuration files.  Among possible objections they may have are:
<ul>
<ul>
<li>a key file being writable by anyone other than the user (eg  
<li>a key file being writable by anyone other than the user (eg  
  group-writable)
  group-writable)
<li>a private key file being readable by anyone other than the user.
<li>a private key file being readable by anyone other than the user.
</ul>
</ul></p>
 
<h4>Wrong ssh protocol version</h4>
<h4>Wrong ssh protocol version</h4>
 
<p>
Most ssh clients and servers support both v1.5 and v2 of the ssh protocol.
Most ssh clients and servers support both v1.5 and v2 of the ssh protocol.
 
<p>
Sometimes, however, they'll both decide to prefer v1.5 even though they both support v2.  In such cases, your ssh-rsa key (which is v2 compliant) won't work.
Sometimes, however, they'll both decide to prefer v1.5 even though they  
 
both support v2.  In such cases, your ssh-rsa key (which is v2 compliant)
<em>Solution</em>:  Force v2 by using the <code>-2</code> flag to ssh or slogin
won't work.
 
<p>
<em>Solution</em>:  Force v2 by using the <code>-2</code> flag to ssh or
slogin
</p>
<pre>
<pre>
     ssh -2 -i ~/.ssh/my_private_key remotemachine
     ssh -2 -i ~/.ssh/my_private_key remotemachine
</pre>
</pre>
<h4>failure to use the right authentication mechanisms</h4>
<h4>failure to use the right authentication mechanisms</h4>
 
<p>
The client can be configured to request particular authentication mechanisms in a particular order.  A non-standard local configuration file can therefore potentially lead the client to prompt for a password before in a particular ordera successful keybased authentication can occur.
The client can be configured to request particular authentication mechanisms
 
in a particular order.  A non-standard local configuration file can  
The following options passed to ssh or slogin should compel the client to only offer/try the key-based authentication mechanism only:
therefore potentially lead the client to prompt for a password before
 
in a particular ordera successful keybased authentication
can occur.
<p>
The following options passed to ssh or slogin should compel the client to
only offer/try the key-based authentication mechanism only:
</p>
<pre>
<pre>
   ssh -2 -i ~/.ssh/my_private_key \
   ssh -2 -i ~/.ssh/my_private_key \
Line 180: Line 252:
       remotemachine
       remotemachine
</pre>
</pre>
<p>
This may be a useful way of minimising the chances of an entirely autonomous
ssh-based command execution failing due to attempting a user interaction.
</p>
Please note that all contributions to NodeSpace Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see NodeSpace Wiki:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)