SSH Config Language

Provides highlighting and snippets in Sublime Text for ~/.ssh/config, /etc/ssh/sshd_config, and some other SSH-related files.

The highlighting is not automatically activated on ~/.ssh/config because of a Sublime Text limitation. Use SSH Config: Open SSH Config File from the command palette or see the wiki for other options.

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 Preferences: 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

• Syntax highlighting
• host snippet creates a new Host entry
• match snippet creates a new Match entry
• Snippets and Keyword completion for most parameters
• 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 (notably .git/config) and we don't want to set the wrong highlighting for those. Several solutions are available on the wiki.

For file format information, consult man pages on the web (Linux, BSD, or Mac), or locally on your machine with

man 5 ssh_config

SSHD Config files

• Syntax highlighting
• match snippet creates a new Match entry
• Snippets and Keyword completion for most parameters
• Symbol Index for active and commented-out config options (Ctrl+R or Cmd+R)
• Automatic indentation

For file format information, consult man pages on the web (Linux, BSD, or Mac), or locally on your machine with

man 5 sshd_config

Authorized Keys files

• Syntax highlighting
• Keyword completion for access restrictions
• Symbol Index for annotations, which are typically the user@host (Ctrl+R or Cmd+R)

For file format information, consult man pages on the web (Linux, BSD, or Mac), or locally on your machine with

PAGER='less -p ^"AUTHORIZED_KEYS"' man 8 sshd

Known Hosts files

• Syntax highlighting
• Symbol Index for hosts and IPs (Ctrl+R or Cmd+R)

For file format information, consult man pages on the web (Linux, BSD, or Mac), or locally on your machine with

PAGER='less -p ^"SSH_KNOWN_HOSTS"' man 8 sshd

Extras

• PEM, PKCS1, PKCS8, and SSH keys have
  • Syntax highlighting
  • Symbol index for cert bundles
• Completion and highlighting for crypto stuff
  • Key types (ssh -Q key)
  • KEX algorithms (ssh -Q kex)
  • Encryption ciphers (ssh -Q ciphers)
  • MACs (ssh -Q mac)

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 test 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.