org.simantics.maps.server/node/node-v4.8.0-win-x64/node_modules/npm/node_modules/request/node_modules/http-signature/node_modules/sshpk/README.md

   1 sshpk
   2 =========
   3
   4 Parse, convert, fingerprint and use SSH keys (both public and private) in pure
   5 node -- no `ssh-keygen` or other external dependencies.
   6
   7 Supports RSA, DSA, ECDSA (nistp-\*) and ED25519 key types, in PEM (PKCS#1,
   8 PKCS#8) and OpenSSH formats.
   9
  10 This library has been extracted from
  11 [`node-http-signature`](https://github.com/joyent/node-http-signature)
  12 (work by [Mark Cavage](https://github.com/mcavage) and
  13 [Dave Eddy](https://github.com/bahamas10)) and
  14 [`node-ssh-fingerprint`](https://github.com/bahamas10/node-ssh-fingerprint)
  15 (work by Dave Eddy), with additions (including ECDSA support) by
  16 [Alex Wilson](https://github.com/arekinath).
  17
  18 Install
  19 -------
  20
  21 ```
  22 npm install sshpk
  23 ```
  24
  25 Examples
  26 --------
  27
  28 ```js
  29 var sshpk = require('sshpk');
  30
  31 var fs = require('fs');
  32
  33 /* Read in an OpenSSH-format public key */
  34 var keyPub = fs.readFileSync('id_rsa.pub');
  35 var key = sshpk.parseKey(keyPub, 'ssh');
  36
  37 /* Get metadata about the key */
  38 console.log('type => %s', key.type);
  39 console.log('size => %d bits', key.size);
  40 console.log('comment => %s', key.comment);
  41
  42 /* Compute key fingerprints, in new OpenSSH (>6.7) format, and old MD5 */
  43 console.log('fingerprint => %s', key.fingerprint().toString());
  44 console.log('old-style fingerprint => %s', key.fingerprint('md5').toString());
  45 ```
  46
  47 Example output:
  48
  49 ```
  50 type => rsa
  51 size => 2048 bits
  52 comment => foo@foo.com
  53 fingerprint => SHA256:PYC9kPVC6J873CSIbfp0LwYeczP/W4ffObNCuDJ1u5w
  54 old-style fingerprint => a0:c8:ad:6c:32:9a:32:fa:59:cc:a9:8c:0a:0d:6e:bd
  55 ```
  56
  57 More examples: converting between formats:
  58
  59 ```js
  60 /* Read in a PEM public key */
  61 var keyPem = fs.readFileSync('id_rsa.pem');
  62 var key = sshpk.parseKey(keyPem, 'pem');
  63
  64 /* Convert to PEM PKCS#8 public key format */
  65 var pemBuf = key.toBuffer('pkcs8');
  66
  67 /* Convert to SSH public key format (and return as a string) */
  68 var sshKey = key.toString('ssh');
  69 ```
  70
  71 Signing and verifying:
  72
  73 ```js
  74 /* Read in an OpenSSH/PEM *private* key */
  75 var keyPriv = fs.readFileSync('id_ecdsa');
  76 var key = sshpk.parsePrivateKey(keyPriv, 'pem');
  77
  78 var data = 'some data';
  79
  80 /* Sign some data with the key */
  81 var s = key.createSign('sha1');
  82 s.update(data);
  83 var signature = s.sign();
  84
  85 /* Now load the public key (could also use just key.toPublic()) */
  86 var keyPub = fs.readFileSync('id_ecdsa.pub');
  87 key = sshpk.parseKey(keyPub, 'ssh');
  88
  89 /* Make a crypto.Verifier with this key */
  90 var v = key.createVerify('sha1');
  91 v.update(data);
  92 var valid = v.verify(signature);
  93 /* => true! */
  94 ```
  95
  96 Matching fingerprints with keys:
  97
  98 ```js
  99 var fp = sshpk.parseFingerprint('SHA256:PYC9kPVC6J873CSIbfp0LwYeczP/W4ffObNCuDJ1u5w');
 100
 101 var keys = [sshpk.parseKey(...), sshpk.parseKey(...), ...];
 102
 103 keys.forEach(function (key) {
 104         if (fp.matches(key))
 105                 console.log('found it!');
 106 });
 107 ```
 108
 109 Usage
 110 -----
 111
 112 ## Public keys
 113
 114 ### `parseKey(data[, format = 'auto'[, options]])`
 115
 116 Parses a key from a given data format and returns a new `Key` object.
 117
 118 Parameters
 119
 120 - `data` -- Either a Buffer or String, containing the key
 121 - `format` -- String name of format to use, valid options are:
 122   - `auto`: choose automatically from all below
 123   - `pem`: supports both PKCS#1 and PKCS#8
 124   - `ssh`: standard OpenSSH format,
 125   - `pkcs1`, `pkcs8`: variants of `pem`
 126   - `rfc4253`: raw OpenSSH wire format
 127   - `openssh`: new post-OpenSSH 6.5 internal format, produced by
 128                `ssh-keygen -o`
 129 - `options` -- Optional Object, extra options, with keys:
 130   - `filename` -- Optional String, name for the key being parsed
 131                   (eg. the filename that was opened). Used to generate
 132                   Error messages
 133   - `passphrase` -- Optional String, encryption passphrase used to decrypt an
 134                     encrypted PEM file
 135
 136 ### `Key.isKey(obj)`
 137
 138 Returns `true` if the given object is a valid `Key` object created by a version
 139 of `sshpk` compatible with this one.
 140
 141 Parameters
 142
 143 - `obj` -- Object to identify
 144
 145 ### `Key#type`
 146
 147 String, the type of key. Valid options are `rsa`, `dsa`, `ecdsa`.
 148
 149 ### `Key#size`
 150
 151 Integer, "size" of the key in bits. For RSA/DSA this is the size of the modulus;
 152 for ECDSA this is the bit size of the curve in use.
 153
 154 ### `Key#comment`
 155
 156 Optional string, a key comment used by some formats (eg the `ssh` format).
 157
 158 ### `Key#curve`
 159
 160 Only present if `this.type === 'ecdsa'`, string containing the name of the
 161 named curve used with this key. Possible values include `nistp256`, `nistp384`
 162 and `nistp521`.
 163
 164 ### `Key#toBuffer([format = 'ssh'])`
 165
 166 Convert the key into a given data format and return the serialized key as
 167 a Buffer.
 168
 169 Parameters
 170
 171 - `format` -- String name of format to use, for valid options see `parseKey()`
 172
 173 ### `Key#toString([format = 'ssh])`
 174
 175 Same as `this.toBuffer(format).toString()`.
 176
 177 ### `Key#fingerprint([algorithm = 'sha256'])`
 178
 179 Creates a new `Fingerprint` object representing this Key's fingerprint.
 180
 181 Parameters
 182
 183 - `algorithm` -- String name of hash algorithm to use, valid options are `md5`,
 184                  `sha1`, `sha256`, `sha384`, `sha512`
 185
 186 ### `Key#createVerify([hashAlgorithm])`
 187
 188 Creates a `crypto.Verifier` specialized to use this Key (and the correct public
 189 key algorithm to match it). The returned Verifier has the same API as a regular
 190 one, except that the `verify()` function takes only the target signature as an
 191 argument.
 192
 193 Parameters
 194
 195 - `hashAlgorithm` -- optional String name of hash algorithm to use, any
 196                      supported by OpenSSL are valid, usually including
 197                      `sha1`, `sha256`.
 198
 199 `v.verify(signature[, format])` Parameters
 200
 201 - `signature` -- either a Signature object, or a Buffer or String
 202 - `format` -- optional String, name of format to interpret given String with.
 203               Not valid if `signature` is a Signature or Buffer.
 204
 205 ### `Key#createDiffieHellman()`
 206 ### `Key#createDH()`
 207
 208 Creates a Diffie-Hellman key exchange object initialized with this key and all
 209 necessary parameters. This has the same API as a `crypto.DiffieHellman`
 210 instance, except that functions take `Key` and `PrivateKey` objects as
 211 arguments, and return them where indicated for.
 212
 213 This is only valid for keys belonging to a cryptosystem that supports DHE
 214 or a close analogue (i.e. `dsa`, `ecdsa` and `curve25519` keys). An attempt
 215 to call this function on other keys will yield an `Error`.
 216
 217 ## Private keys
 218
 219 ### `parsePrivateKey(data[, format = 'auto'[, options]])`
 220
 221 Parses a private key from a given data format and returns a new
 222 `PrivateKey` object.
 223
 224 Parameters
 225
 226 - `data` -- Either a Buffer or String, containing the key
 227 - `format` -- String name of format to use, valid options are:
 228   - `auto`: choose automatically from all below
 229   - `pem`: supports both PKCS#1 and PKCS#8
 230   - `ssh`, `openssh`: new post-OpenSSH 6.5 internal format, produced by
 231                       `ssh-keygen -o`
 232   - `pkcs1`, `pkcs8`: variants of `pem`
 233   - `rfc4253`: raw OpenSSH wire format
 234 - `options` -- Optional Object, extra options, with keys:
 235   - `filename` -- Optional String, name for the key being parsed
 236                   (eg. the filename that was opened). Used to generate
 237                   Error messages
 238   - `passphrase` -- Optional String, encryption passphrase used to decrypt an
 239                     encrypted PEM file
 240
 241 ### `PrivateKey.isPrivateKey(obj)`
 242
 243 Returns `true` if the given object is a valid `PrivateKey` object created by a
 244 version of `sshpk` compatible with this one.
 245
 246 Parameters
 247
 248 - `obj` -- Object to identify
 249
 250 ### `PrivateKey#type`
 251
 252 String, the type of key. Valid options are `rsa`, `dsa`, `ecdsa`.
 253
 254 ### `PrivateKey#size`
 255
 256 Integer, "size" of the key in bits. For RSA/DSA this is the size of the modulus;
 257 for ECDSA this is the bit size of the curve in use.
 258
 259 ### `PrivateKey#curve`
 260
 261 Only present if `this.type === 'ecdsa'`, string containing the name of the
 262 named curve used with this key. Possible values include `nistp256`, `nistp384`
 263 and `nistp521`.
 264
 265 ### `PrivateKey#toBuffer([format = 'pkcs1'])`
 266
 267 Convert the key into a given data format and return the serialized key as
 268 a Buffer.
 269
 270 Parameters
 271
 272 - `format` -- String name of format to use, valid options are listed under
 273               `parsePrivateKey`. Note that ED25519 keys default to `openssh`
 274               format instead (as they have no `pkcs1` representation).
 275
 276 ### `PrivateKey#toString([format = 'pkcs1'])`
 277
 278 Same as `this.toBuffer(format).toString()`.
 279
 280 ### `PrivateKey#toPublic()`
 281
 282 Extract just the public part of this private key, and return it as a `Key`
 283 object.
 284
 285 ### `PrivateKey#fingerprint([algorithm = 'sha256'])`
 286
 287 Same as `this.toPublic().fingerprint()`.
 288
 289 ### `PrivateKey#createVerify([hashAlgorithm])`
 290
 291 Same as `this.toPublic().createVerify()`.
 292
 293 ### `PrivateKey#createSign([hashAlgorithm])`
 294
 295 Creates a `crypto.Sign` specialized to use this PrivateKey (and the correct
 296 key algorithm to match it). The returned Signer has the same API as a regular
 297 one, except that the `sign()` function takes no arguments, and returns a
 298 `Signature` object.
 299
 300 Parameters
 301
 302 - `hashAlgorithm` -- optional String name of hash algorithm to use, any
 303                      supported by OpenSSL are valid, usually including
 304                      `sha1`, `sha256`.
 305
 306 `v.sign()` Parameters
 307
 308 - none
 309
 310 ### `PrivateKey#derive(newType)`
 311
 312 Derives a related key of type `newType` from this key. Currently this is
 313 only supported to change between `ed25519` and `curve25519` keys which are
 314 stored with the same private key (but usually distinct public keys in order
 315 to avoid degenerate keys that lead to a weak Diffie-Hellman exchange).
 316
 317 Parameters
 318
 319 - `newType` -- String, type of key to derive, either `ed25519` or `curve25519`
 320
 321 ## Fingerprints
 322
 323 ### `parseFingerprint(fingerprint[, algorithms])`
 324
 325 Pre-parses a fingerprint, creating a `Fingerprint` object that can be used to
 326 quickly locate a key by using the `Fingerprint#matches` function.
 327
 328 Parameters
 329
 330 - `fingerprint` -- String, the fingerprint value, in any supported format
 331 - `algorithms` -- Optional list of strings, names of hash algorithms to limit
 332                   support to. If `fingerprint` uses a hash algorithm not on
 333                   this list, throws `InvalidAlgorithmError`.
 334
 335 ### `Fingerprint.isFingerprint(obj)`
 336
 337 Returns `true` if the given object is a valid `Fingerprint` object created by a
 338 version of `sshpk` compatible with this one.
 339
 340 Parameters
 341
 342 - `obj` -- Object to identify
 343
 344 ### `Fingerprint#toString([format])`
 345
 346 Returns a fingerprint as a string, in the given format.
 347
 348 Parameters
 349
 350 - `format` -- Optional String, format to use, valid options are `hex` and
 351               `base64`. If this `Fingerprint` uses the `md5` algorithm, the
 352               default format is `hex`. Otherwise, the default is `base64`.
 353
 354 ### `Fingerprint#matches(key)`
 355
 356 Verifies whether or not this `Fingerprint` matches a given `Key`. This function
 357 uses double-hashing to avoid leaking timing information. Returns a boolean.
 358
 359 Parameters
 360
 361 - `key` -- a `Key` object, the key to match this fingerprint against
 362
 363 ## Signatures
 364
 365 ### `parseSignature(signature, algorithm, format)`
 366
 367 Parses a signature in a given format, creating a `Signature` object. Useful
 368 for converting between the SSH and ASN.1 (PKCS/OpenSSL) signature formats, and
 369 also returned as output from `PrivateKey#createSign().sign()`.
 370
 371 A Signature object can also be passed to a verifier produced by
 372 `Key#createVerify()` and it will automatically be converted internally into the
 373 correct format for verification.
 374
 375 Parameters
 376
 377 - `signature` -- a Buffer (binary) or String (base64), data of the actual
 378                  signature in the given format
 379 - `algorithm` -- a String, name of the algorithm to be used, possible values
 380                  are `rsa`, `dsa`, `ecdsa`
 381 - `format` -- a String, either `asn1` or `ssh`
 382
 383 ### `Signature.isSignature(obj)`
 384
 385 Returns `true` if the given object is a valid `Signature` object created by a
 386 version of `sshpk` compatible with this one.
 387
 388 Parameters
 389
 390 - `obj` -- Object to identify
 391
 392 ### `Signature#toBuffer([format = 'asn1'])`
 393
 394 Converts a Signature to the given format and returns it as a Buffer.
 395
 396 Parameters
 397
 398 - `format` -- a String, either `asn1` or `ssh`
 399
 400 ### `Signature#toString([format = 'asn1'])`
 401
 402 Same as `this.toBuffer(format).toString('base64')`.
 403
 404 ## Certificates
 405
 406 `sshpk` includes basic support for parsing certificates in X.509 (PEM) format
 407 and the OpenSSH certificate format. This feature is intended to be used mainly
 408 to access basic metadata about certificates, extract public keys from them, and
 409 also to generate simple self-signed certificates from an existing key.
 410
 411 Notably, there is no implementation of CA chain-of-trust verification, and no
 412 support for key usage restrictions (or other kinds of restrictions). Please do
 413 the security world a favour, and DO NOT use this code for certificate
 414 verification in the traditional X.509 CA chain style.
 415
 416 ### `parseCertificate(data, format)`
 417
 418 Parameters
 419
 420  - `data` -- a Buffer or String
 421  - `format` -- a String, format to use, one of `'openssh'`, `'pem'` (X.509 in a
 422                PEM wrapper), or `'x509'` (raw DER encoded)
 423
 424 ### `createSelfSignedCertificate(subject, privateKey[, options])`
 425
 426 Parameters
 427
 428  - `subject` -- an Identity, the subject of the certificate
 429  - `privateKey` -- a PrivateKey, the key of the subject: will be used both to be
 430                    placed in the certificate and also to sign it (since this is
 431                    a self-signed certificate)
 432  - `options` -- optional Object, with keys:
 433    - `lifetime` -- optional Number, lifetime of the certificate from now in
 434                    seconds
 435    - `validFrom`, `validUntil` -- optional Dates, beginning and end of
 436                                   certificate validity period. If given
 437                                   `lifetime` will be ignored
 438    - `serial` -- optional Buffer, the serial number of the certificate
 439
 440 ### `createCertificate(subject, key, issuer, issuerKey[, options])`
 441
 442 Parameters
 443
 444  - `subject` -- an Identity, the subject of the certificate
 445  - `key` -- a Key, the public key of the subject
 446  - `issuer` -- an Identity, the issuer of the certificate who will sign it
 447  - `issuerKey` -- a PrivateKey, the issuer's private key for signing
 448  - `options` -- optional Object, with keys:
 449    - `lifetime` -- optional Number, lifetime of the certificate from now in
 450                    seconds
 451    - `validFrom`, `validUntil` -- optional Dates, beginning and end of
 452                                   certificate validity period. If given
 453                                   `lifetime` will be ignored
 454    - `serial` -- optional Buffer, the serial number of the certificate
 455
 456 ### `Certificate#subjects`
 457
 458 Array of `Identity` instances describing the subject of this certificate.
 459
 460 ### `Certificate#issuer`
 461
 462 The `Identity` of the Certificate's issuer (signer).
 463
 464 ### `Certificate#subjectKey`
 465
 466 The public key of the subject of the certificate, as a `Key` instance.
 467
 468 ### `Certificate#issuerKey`
 469
 470 The public key of the signing issuer of this certificate, as a `Key` instance.
 471 May be `undefined` if the issuer's key is unknown (e.g. on an X509 certificate).
 472
 473 ### `Certificate#serial`
 474
 475 The serial number of the certificate. As this is normally a 64-bit or wider
 476 integer, it is returned as a Buffer.
 477
 478 ### `Certificate#isExpired([when])`
 479
 480 Tests whether the Certificate is currently expired (i.e. the `validFrom` and
 481 `validUntil` dates specify a range of time that does not include the current
 482 time).
 483
 484 Parameters
 485
 486  - `when` -- optional Date, if specified, tests whether the Certificate was or
 487              will be expired at the specified time instead of now
 488
 489 Returns a Boolean.
 490
 491 ### `Certificate#isSignedByKey(key)`
 492
 493 Tests whether the Certificate was validly signed by the given (public) Key.
 494
 495 Parameters
 496
 497  - `key` -- a Key instance
 498
 499 Returns a Boolean.
 500
 501 ### `Certificate#isSignedBy(certificate)`
 502
 503 Tests whether this Certificate was validly signed by the subject of the given
 504 certificate. Also tests that the issuer Identity of this Certificate and the
 505 subject Identity of the other Certificate are equivalent.
 506
 507 Parameters
 508
 509  - `certificate` -- another Certificate instance
 510
 511 Returns a Boolean.
 512
 513 ### `Certificate#fingerprint([hashAlgo])`
 514
 515 Returns the X509-style fingerprint of the entire certificate (as a Fingerprint
 516 instance). This matches what a web-browser or similar would display as the
 517 certificate fingerprint and should not be confused with the fingerprint of the
 518 subject's public key.
 519
 520 Parameters
 521
 522  - `hashAlgo` -- an optional String, any hash function name
 523
 524 ### `Certificate#toBuffer([format])`
 525
 526 Serializes the Certificate to a Buffer and returns it.
 527
 528 Parameters
 529
 530  - `format` -- an optional String, output format, one of `'openssh'`, `'pem'` or
 531                `'x509'`. Defaults to `'x509'`.
 532
 533 Returns a Buffer.
 534
 535 ### `Certificate#toString([format])`
 536
 537  - `format` -- an optional String, output format, one of `'openssh'`, `'pem'` or
 538                `'x509'`. Defaults to `'pem'`.
 539
 540 Returns a String.
 541
 542 ## Certificate identities
 543
 544 ### `identityForHost(hostname)`
 545
 546 Constructs a host-type Identity for a given hostname.
 547
 548 Parameters
 549
 550  - `hostname` -- the fully qualified DNS name of the host
 551
 552 Returns an Identity instance.
 553
 554 ### `identityForUser(uid)`
 555
 556 Constructs a user-type Identity for a given UID.
 557
 558 Parameters
 559
 560  - `uid` -- a String, user identifier (login name)
 561
 562 Returns an Identity instance.
 563
 564 ### `identityForEmail(email)`
 565
 566 Constructs an email-type Identity for a given email address.
 567
 568 Parameters
 569
 570  - `email` -- a String, email address
 571
 572 Returns an Identity instance.
 573
 574 ### `identityFromDN(dn)`
 575
 576 Parses an LDAP-style DN string (e.g. `'CN=foo, C=US'`) and turns it into an
 577 Identity instance.
 578
 579 Parameters
 580
 581  - `dn` -- a String
 582
 583 Returns an Identity instance.
 584
 585 ### `Identity#toString()`
 586
 587 Returns the identity as an LDAP-style DN string.
 588 e.g. `'CN=foo, O=bar corp, C=us'`
 589
 590 ### `Identity#type`
 591
 592 The type of identity. One of `'host'`, `'user'`, `'email'` or `'unknown'`
 593
 594 ### `Identity#hostname`
 595 ### `Identity#uid`
 596 ### `Identity#email`
 597
 598 Set when `type` is `'host'`, `'user'`, or `'email'`, respectively. Strings.
 599
 600 ### `Identity#cn`
 601
 602 The value of the first `CN=` in the DN, if any.
 603
 604 Errors
 605 ------
 606
 607 ### `InvalidAlgorithmError`
 608
 609 The specified algorithm is not valid, either because it is not supported, or
 610 because it was not included on a list of allowed algorithms.
 611
 612 Thrown by `Fingerprint.parse`, `Key#fingerprint`.
 613
 614 Properties
 615
 616 - `algorithm` -- the algorithm that could not be validated
 617
 618 ### `FingerprintFormatError`
 619
 620 The fingerprint string given could not be parsed as a supported fingerprint
 621 format, or the specified fingerprint format is invalid.
 622
 623 Thrown by `Fingerprint.parse`, `Fingerprint#toString`.
 624
 625 Properties
 626
 627 - `fingerprint` -- if caused by a fingerprint, the string value given
 628 - `format` -- if caused by an invalid format specification, the string value given
 629
 630 ### `KeyParseError`
 631
 632 The key data given could not be parsed as a valid key.
 633
 634 Properties
 635
 636 - `keyName` -- `filename` that was given to `parseKey`
 637 - `format` -- the `format` that was trying to parse the key (see `parseKey`)
 638 - `innerErr` -- the inner Error thrown by the format parser
 639
 640 ### `KeyEncryptedError`
 641
 642 The key is encrypted with a symmetric key (ie, it is password protected). The
 643 parsing operation would succeed if it was given the `passphrase` option.
 644
 645 Properties
 646
 647 - `keyName` -- `filename` that was given to `parseKey`
 648 - `format` -- the `format` that was trying to parse the key (currently can only
 649               be `"pem"`)
 650
 651 ### `CertificateParseError`
 652
 653 The certificate data given could not be parsed as a valid certificate.
 654
 655 Properties
 656
 657 - `certName` -- `filename` that was given to `parseCertificate`
 658 - `format` -- the `format` that was trying to parse the key
 659               (see `parseCertificate`)
 660 - `innerErr` -- the inner Error thrown by the format parser
 661
 662 Friends of sshpk
 663 ----------------
 664
 665  * [`sshpk-agent`](https://github.com/arekinath/node-sshpk-agent) is a library
 666    for speaking the `ssh-agent` protocol from node.js, which uses `sshpk`