SSH Config Language

Provides highlighting and snippets for ~/.ssh/config and /etc/ssh/sshd_config files in Sublime Text.

Installation

This package is available via Package Control. You can install it by searching for SSH in the Package Control: Install Package interface or by cloning this repository into your Sublime Text Packages directory.

Features

Commands

• Edit package settings
• Quick open files:
  • SSH Config
  • SSHD Config
  • Authorized Keys
  • Known Hosts

If the file-open commands open the wrong file for you, open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P), search for SSH Config: Settings, and put in content like this:

{
    "file_locations": {
        "ssh_config": "~/.ssh/config",
        "sshd_config": "/etc/ssh/sshd_config",
        "known_hosts": "~/.ssh/known_hosts",
        "authorized_keys": "~/.ssh/authorized_keys",
    },
}

SSH Config files

• host snippet creates a new Host entry
• match snippet creates a new Match entry
• Keyword completion for many Linux and BSD options
• Symbol Index for hosts and aliases (Ctrl+R or Cmd+R)
• Automatic indentation

Note that ~/.ssh/config is not linked to the SSH Config syntax highlighting out of the box. This is because the filename is shared by other formats (e.g. .git/config) and we don't want to set the wrong highlighting for those. Several solutions are available on the wiki.

SSHD Config files

• Keyword completion for many Linux and BSD options
• Symbol Index for active and commented-out config options (Ctrl+R or Cmd+R)
• Automatic indentation

Extras

• Authorized Keys and Known Hosts files also have
  • Syntax highlighting
  • Symbol index
• PEM, PKCS1, PKCS8, and SSH keys have
  • Syntax highlighting
  • Symbol index for cert bundles
• Completion and highlighting for crypto stuff
  • Key types
  • KEX algorithms
  • Encryption ciphers
  • MACs

Building

• Snippets, completions, and crypto names are built from the src directory in a simple Python script. Its only requirement is pyyaml.
• Changes to any of the above should be modified in YAML and rebuilt.
• Changes to syntaxes do not need rebuilding, but do need regression testing.

Syntax testing

• Install this repository under Sublime Text Packages and name it SSH Config.
  • You can clone it there directly, move it there, or symlink it.
• Open the project from under Packages/SSH Config.
• Open a syntax test file located in the Tests directory.
• Run the Build With: Syntax Tests command.
  • This is supplied by the Default Package, which is shipped with Sublime Text.
  • The command is available on the Command Palette when any test file is open.

The PackageDev package is helpful for writing tests but not required.