ssh-config
SSH config parser and stringifier
Last updated 6 months ago by dotnil .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install ssh-config 
SYNC missed versions from official npm registry.

SSH Config Parser & Stringifier

NPM Downloads NPM Version Build Status Coverage Status

Usage

const SSHConfig = require('ssh-config')

const config = SSHConfig.parse(`
  IdentityFile ~/.ssh/id_rsa

  Host tahoe
    HostName tahoe.com

  Host walden
    HostName waldenlake.org

  Host *
    User keanu
    ForwardAgent true
`)

expect(config).to.eql(
  [ { "param": "IdentityFile",
      "value": "~/.ssh/id_rsa" },
    { "param": "Host",
      "value": "tahoe",
      "config":
        [ { "param": "HostName",
            "value": "tahoe.com" } ] },
    { "param": "Host",
      "value": "walden",
      "config":
        [ { "param": "HostName",
            "value": "waldenlake.org" } ] },
    { "param": "Host",
      "value": "*",
      "config":
        [ { "param": "User",
            "value": "keanu" },
          { "param": "ForwardAgent",
            "value": "true" } ] } ]
)

// Change the HostName in the Host walden section
const section = config.find({ Host: 'walden' })

for (const line of section.config) {
  if (line.param === 'HostName') {
    line.value = 'waldenlake.org'
    break
  }
}

// The original whitespaces and comments are preserved.
console.log(SSHConfig.stringify(config))
// console.log(config.toString())

Iterating over Sections

One needs to iterate over ssh configs mostly because of two reasons.

  • to .find the corresponding section and modify it, or
  • to .compute the ssh config about certain Host.

.compute Parameters by Host

You can use config.compute method to compute applied parameters of certain host.

expect(config.compute('walden')).to.eql({
  IdentityFile: [
    '~/.ssh/id_rsa'
  ],
  Host: 'walden',
  HostName: 'waldenlake.org',
  User: 'nil',
  ForwardAgent: 'true'
})

NOTICE According to ssh_config(5), the first obtained parameter value will be used. So we cannot override existing parameters. It is suggested that the general settings shall be at the end of your config file.

The IdentityFile parameter always contain an array to make possible multiple IdentityFile settings to be able to coexist.

.find sections by Host or Match

NOTICE: This method is provided to find the corresponding section in the parsed config for config manipulation. It is NOT intended to compute config of certain Host. For latter case, use .compute(host) instead.

To ditch boilerplate codes like the for loop shown earlier, we can use the .find(opts) available in the parsed config object.

config.find({ Host: 'example1' })
// or the ES2015 Array.prototype.find
config.find(line => line.param == 'Host' && line.value == 'example1')

.remove sections by Host or other criteria

To remove sections, we can pass the section to .remove(opts).

config.remove({ Host: 'example1' })

.append sections

Since the parsed config is a sub class of Array, you can append new sections with methods like .push or .concat.

config.push(SSHConfig.parse(`
Host ness
  HostName lochness.com
  User dinosaur
`))

expect(config.find({ Host: '*' })).to.eql(
  { "param": "Host",
    "value": "ness",
    "config":
     [ { "param": "HostName",
         "value": "lochness.com" } ] }
)

If the section to append is vanilla JSON, .append is what you need.

const config = new SSHConfig()

config.append({
  Host: 'ness',
  HostName: 'lochness.com',
  User: 'dinosaur'
})

SSHConfig.stringify(config)
// =>
// Host ness
//   HostName lochness.com
//   User dinosaur

References

Current Tags

  • 4.0.2                                ...           latest (6 months ago)

21 Versions

  • 4.0.2                                ...           6 months ago
  • 4.0.1                                ...           6 months ago
  • 4.0.0                                ...           7 months ago
  • 3.0.1                                ...           7 months ago
  • 3.0.0                                ...           8 months ago
  • 2.0.0                                ...           10 months ago
  • 2.0.0-beta.1                                ...           a year ago
  • 2.0.0-alpha.3                                ...           a year ago
  • 2.0.0-alpha.2                                ...           a year ago
  • 2.0.0-alpha.1                                ...           a year ago
  • 1.1.6                                ...           a year ago
  • 1.1.5                                ...           2 years ago
  • 1.1.3                                ...           3 years ago
  • 1.1.2                                ...           3 years ago
  • 1.1.1                                ...           3 years ago
  • 1.1.0                                ...           3 years ago
  • 1.0.1                                ...           3 years ago
  • 1.0.0                                ...           4 years ago
  • 0.2.1                                ...           5 years ago
  • 0.2.0                                ...           5 years ago
  • 0.1.0                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 108
This Month 176
Last Day 108
Last Week 697
Last Month 2,716
Dependencies (0)
None
Dev Dependencies (3)

Copyright 2014 - 2016 © taobao.org |