Skip to content

Commit 44d9b19

Browse files
hanybobveznat
authored andcommitted
Use double backquotes due to RST format for USAGE
1 parent 2547c51 commit 44d9b19

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

USAGE.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ example you might have separate environments for staging and production
1919
each with different CAs. This tool supports that.
2020

2121
Here's a sample requester config file. The default location for this is
22-
`$HOME/.ssh_ca/requester_config.json` ::
22+
``$HOME/.ssh_ca/requester_config.json`` ::
2323
{
2424
"stage": {
2525
"PublicKeyFingerprint": "17:04:57:a6:b8:49:94:ab:ca:0f:5e:60:8e:6d:e0:df",
@@ -34,7 +34,7 @@ Here's a sample requester config file. The default location for this is
3434
The contents should be reasonably self explanatory. Here we have a json
3535
blob containing a stage and prod environment. The user has chosen to use
3636
different SSH keys for production and staging, however, this is not
37-
required. The `SignerUrl` is the location of the ssh-cert-authority daemon.
37+
required. The ``SignerUrl`` is the location of the ssh-cert-authority daemon.
3838

3939
Making a request
4040
----------------
@@ -50,15 +50,15 @@ This will print out a certificate request id like so::
5050
Hand this id off to someone that can sign your cert.
5151

5252
If instead you got an error like
53-
`ssh-add the private half of the key you want to use.` then go do that.
54-
Under the hood the `request_cert` command is going to use your SSH
53+
``ssh-add the private half of the key you want to use.`` then go do that.
54+
Under the hood the ``request`` command is going to use your SSH
5555
private key to sign your certificate request. This is how the signing
5656
daemon knows that you are the person that actually requested the cert
5757
(you have control of the private key and your private key is actually
58-
private, right?). This is typically as simple as `ssh-add ~/.ssh/id_rsa`
58+
private, right?). This is typically as simple as ``ssh-add ~/.ssh/id_rsa``
5959
but if you've got lots of keys or per-environment config you'll need to
6060
adjust and ensure you both add the right key and that your
61-
`requester_config.json` is specifying the right public key.
61+
``requester_config.json`` is specifying the right public key.
6262

6363
Signing certificates
6464
====================
@@ -71,7 +71,7 @@ Configuration
7171
-------------
7272

7373
A sample signer config. By default this is in
74-
`$HOME/.ssh_ca/signer_config.json` ::
74+
``$HOME/.ssh_ca/signer_config.json`` ::
7575

7676
{
7777
"stage": {
@@ -87,8 +87,8 @@ A sample signer config. By default this is in
8787
In this case the configuration is slightly different from requesting
8888
because we're dealing with fingerprints instead of paths. You can easily
8989
get the fingerprint of the private key you want to sign with by doing
90-
`ssh-keygen -l -f ~/.ssh/id_rsa` or inspecting the output of `ssh-add
91-
-l` (the `ssh-add -l` output is only relevant if your private key is
90+
``ssh-keygen -l -f ~/.ssh/id_rsa`` or inspecting the output of ``ssh-add
91+
-l`` (the ``ssh-add -l`` output is only relevant if your private key is
9292
loaded in your agent).
9393

9494
Signing a request
@@ -113,18 +113,18 @@ id. You then sign it by::
113113

114114
Inspect every field and compare it to what you know about who is requesting
115115
this certificate and why. I'll provide a brief explanation of these here
116-
but for more information checkout the `CERTIFICATES` section of
117-
`ssh-keygen(1)`
116+
but for more information checkout the ``CERTIFICATES`` section of
117+
``ssh-keygen(1)``
118118

119119
- Does the key id match with who requested the cert?
120120
- Principals specifies the list of usernames that a requester can
121121
use to login to systems as. In our example here the user is
122-
allowed to use `ec2-user` and `ubuntu`.
122+
allowed to use ``ec2-user`` and ``ubuntu``.
123123
- Permissions is a list of ssh permissions that this cert grants. In
124-
particular `permit-pty` will allow the user to open up a shell. Here
125-
we also see `permit-agent-forwarding` which allows the user to
126-
forward along their `ssh-agent` connection (generally useful) and
127-
`permit-port-forwarding` which allows the user of this cert to
124+
particular ``permit-pty`` will allow the user to open up a shell. Here
125+
we also see ``permit-agent-forwarding`` which allows the user to
126+
forward along their ``ssh-agent`` connection (generally useful) and
127+
``permit-port-forwarding`` which allows the user of this cert to
128128
forward ports along connections.
129129

130130
Also inspect the validity period. What is normal for your organization?
@@ -133,17 +133,17 @@ is to be abused. sign_cert will print out the expiry time of a
133133
certificate in red if the value is more than 48 hours in the future.
134134

135135
If you, as a signer, are happy with the certificate request you can type
136-
`yes` and the certificate will be, effectively, +1'ed by you.
136+
``yes`` and the certificate will be, effectively, +1'ed by you.
137137

138138
If you believe this request is a Bad Idea and should not be approved by
139139
anyone you can reject it forcefully and authoritatively by typing
140-
`reject`. This will permanently mark the request as rejected and it can
140+
``reject``. This will permanently mark the request as rejected and it can
141141
never be signed after that.
142142

143143
Any other input is ignored and sign_cert exits.
144144

145-
In order for sign_cert to run your SSH key must be loaded in `ssh-agent`
146-
(via `ssh-add`). Otherwise `sign` will exit with an error::
145+
In order for sign_cert to run your SSH key must be loaded in ``ssh-agent``
146+
(via ``ssh-add``). Otherwise ``sign`` will exit with an error::
147147

148148
ssh-add the private half of the key you want to use.
149149

@@ -157,6 +157,6 @@ Super basic
157157
Configuration
158158
-------------
159159

160-
The get command uses the `requester_config.json` file described under
160+
The get command uses the ``requester_config.json`` file described under
161161
requesting a certificate.
162162

0 commit comments

Comments
 (0)