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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
|
package ssh
import (
"net/http"
"strings"
"github.com/pkg/errors"
"github.com/smallstep/certificates/api"
"github.com/smallstep/certificates/authority/provisioner"
"github.com/smallstep/certificates/ca"
"github.com/smallstep/certificates/errs"
"github.com/smallstep/cli/command"
"github.com/smallstep/cli/crypto/keys"
"github.com/smallstep/cli/crypto/sshutil"
"github.com/smallstep/cli/flags"
"github.com/smallstep/cli/token"
"github.com/smallstep/cli/ui"
"github.com/smallstep/cli/utils/cautils"
"github.com/urfave/cli"
"golang.org/x/crypto/ssh"
)
// init creates and registers the ssh command
func init() {
cmd := cli.Command{
Name: "ssh",
Usage: "create and manage ssh certificates",
UsageText: "step ssh <subcommand> [arguments] [global-flags] [subcommand-flags]",
Description: `**step ssh** command group provides facilities to sign SSH certificates.
## EXAMPLES
Generate a new SSH key pair and user certificate:
'''
$ step ssh certificate joe@work id_ecdsa
'''
Generate a new SSH key pair and host certificate:
'''
$ step ssh certificate --host internal.example.com ssh_host_ecdsa_key
'''
Add a new user certificate to the agent:
'''
$ step ssh login joe@example.com
'''
Remove a certificate from the agent:
'''
$ step ssh logout joe@example.com
'''
List all keys in the agent:
'''
$ step ssh list
'''
Configure a user environment with the SSH templates:
'''
$ step ssh config
'''
Inspect an ssh certificate file:
'''
$ step ssh inspect id_ecdsa-cert.pub
'''
Inspect an ssh certificate in the agent:
'''
$ step ssh list --raw joe@example.com | step ssh inspect
'''
List all the hosts you have access to:
'''
$ step ssh hosts
'''
Login into one host:
'''
$ ssh internal.example.com
'''`,
Subcommands: cli.Commands{
certificateCommand(),
configCommand(),
loginCommand(),
logoutCommand(),
inspectCommand(),
listCommand(),
fingerPrintCommand(),
// proxyCommand(),
proxycommandCommand(),
checkHostCommand(),
hostsCommand(),
renewCommand(),
revokeCommand(),
rekeyCommand(),
},
}
command.Register(cmd)
}
var (
sshPrincipalFlag = cli.StringSliceFlag{
Name: "principal,n",
Usage: `Add the specified principal (user or host <name>s) to the certificate request.
This flag can be used multiple times. However, it cannot be used in conjunction
with '--token' when requesting certificates from OIDC, JWK, and X5C provisioners, or
from any provisioner with 'disableCustomSANs' set to 'true'. These provisioners will
use the contents of the token to determine the principals.`,
}
sshHostFlag = cli.BoolFlag{
Name: "host",
Usage: `Create a host certificate instead of a user certificate.`,
}
sshHostIDFlag = cli.StringFlag{
Name: "host-id",
Usage: `Specify a <UUID> to identify the host rather than using an auto-generated UUID.
If "machine" is passed, derive a UUID from "/etc/machine-id."`,
}
sshSignFlag = cli.BoolFlag{
Name: "sign",
Usage: `Sign the public key passed as an argument instead of creating one.`,
}
sshPasswordFileFlag = cli.StringFlag{
Name: "password-file",
Usage: `The path to the <file> containing the password to encrypt the private key.`,
}
sshProvisionerPasswordFlag = cli.StringFlag{
Name: "provisioner-password-file",
Usage: `The path to the <file> containing the password to decrypt the one-time token
generating key.`,
}
sshAddUserFlag = cli.BoolFlag{
Name: "add-user",
Usage: `Create a user provisioner certificate used to create a new user.`,
}
sshPrivateKeyFlag = cli.StringFlag{
Name: "private-key",
Usage: `When signing an existing public key, use this flag to specify the corresponding
private key so that the pair can be added to an SSH Agent.`,
}
)
func loginOnUnauthorized(ctx *cli.Context) (ca.RetryFunc, error) {
templateData, err := flags.ParseTemplateData(ctx)
if err != nil {
return nil, err
}
flow, err := cautils.NewCertificateFlow(ctx)
if err != nil {
return nil, err
}
client, err := cautils.NewClient(ctx)
if err != nil {
return nil, err
}
return func(code int) bool {
if code != http.StatusUnauthorized {
return false
}
fail := func(err error) bool {
ui.Printf("{{ \"%v\" | red }}\n", err)
return false
}
// Generate OIDC token
tok, err := flow.GenerateIdentityToken(ctx)
if err != nil {
return fail(err)
}
jwt, err := token.ParseInsecure(tok)
if err != nil {
return fail(err)
}
if jwt.Payload.Email == "" {
return fail(errors.New("error creating identity token: email address cannot be empty"))
}
// Generate SSH Keys
pub, priv, err := keys.GenerateDefaultKeyPair()
if err != nil {
return fail(err)
}
sshPub, err := ssh.NewPublicKey(pub)
if err != nil {
return fail(err)
}
// Generate identity CSR (x509)
identityCSR, identityKey, err := ca.CreateIdentityRequest(jwt.Payload.Email)
if err != nil {
return fail(err)
}
resp, err := client.SSHSign(&api.SSHSignRequest{
PublicKey: sshPub.Marshal(),
OTT: tok,
CertType: provisioner.SSHUserCert,
KeyID: jwt.Payload.Email,
IdentityCSR: *identityCSR,
TemplateData: templateData,
})
if err != nil {
return fail(err)
}
// Write x509 identity certificate
if err := ca.WriteDefaultIdentity(resp.IdentityCertificate, identityKey); err != nil {
return fail(err)
}
// Add ssh certificate to the agent, ignore errors.
if agent, err := sshutil.DialAgent(); err == nil {
agent.AddCertificate(jwt.Payload.Email, resp.Certificate.Certificate, priv)
}
return true
}, nil
}
// tokenHasEmail returns if the token payload has an email address. This is
// mainly used on OIDC token.
func tokenHasEmail(s string) (string, bool) {
jwt, err := token.ParseInsecure(s)
if err != nil {
return "", false
}
return jwt.Payload.Email, jwt.Payload.Email != ""
}
func sshConfigErr(err error) error {
return &errs.Error{
Err: err,
Msg: "There is a problem with your step configuration. Please run 'step ssh config'.",
}
}
func contactAdminErr(err error) error {
return &errs.Error{
Err: err,
Msg: "There is a problem with your step configuration. Please contact an administrator.",
}
}
func debugErr(err error) error {
return &errs.Error{
Err: err,
Msg: "An error occurred in the step process. Please contact an administrator.",
}
}
// createPrincipalsFromSubject create default principals names for a subject. By
// default it would be the sanitized version of the subject, but if the subject
// is an email it will add the local part if it's different and the email
// address.
func createPrincipalsFromSubject(subject string) []string {
name := provisioner.SanitizeSSHUserPrincipal(subject)
principals := []string{name}
if i := strings.LastIndex(subject, "@"); i >= 0 {
if local := subject[:i]; !strings.EqualFold(local, name) {
principals = append(principals, local)
}
principals = append(principals, subject)
}
return principals
}
|