Home / Linux / System utilities

SSH config export for org-mode

SSH config export for org-mode
Information
Category: Linux / System utilities
Watchers: 1
Star: 18
Fork: 1
Last update: Oct 24, 2020
Resource links
https://github.com/dantecatalfamo/ox-ssh

ox-ssh

https://melpa.org/packages/ox-ssh-badge.svg

SSH configuration export for org-mode.

Commands

ox-ssh provides the following interactive commands:

  • org-ssh-export-as-config Exports to a temporary buffer
  • org-ssh-export-to-config Exports to file with the extension .ssh_config
  • org-ssh-export-overwrite-user-config Exports file, overwrites user’s ~/.ssh/config. Prompts user with yes/no option before doing so.

These commands are also exposed through the org-export-dispatch menu.

Variables

  • org-ssh-header An optional header that will be added to the beginning of the export. This can be used for comments or rules that apply to all hosts.

Usage

Export headings with specific properties as entries in an SSH configuration file. These properties correspond with the client configuration options for SSH.

For a heading to be exported as a host, it must have either a HOSTNAME or IP property. If an entry has both, IP takes precedence. It can also contain one or more optional parameters, listed in the table below.

ssh_config(5) option ox-ssh property
AddKeysToAgent SSH_ADD_KEYS_TO_AGENT
AddressFamily SSH_ADDRESS_FAMILY
BatchMode SSH_BATCH_MODE
BindInterface SSH_BIND_INTERFACE
CanonicalDomains SSH_CANONICAL_DOMAINS
CanonicalizeFallbackLocal SSH_CANONICALIZE_FALLBACK_LOCAL
CanonicalizeHostname SSH_CANONICALIZE_HOSTNAME
CanonicalizeMaxDots SSH_CANONICALIZE_MAX_DOTS
CanonicalizePermittedCNAMEs SSH_CANONICALIZE_PERMITTED_CNAMES
CASignatureAlgorithms SSH_CA_SIGNATURE_ALGORITHMS
CertificateFile SSH_CERTIFICATE_FILE
ChallengeResponseAuthentication SSH_CHALLENGE_RESPONSE_AUTHENTICATION
CheckHostIP SSH_CHECK_HOST_IP
Ciphers SSH_CIPHERS
ClearAllForwardings SSH_CLEAR_ALL_FORWARDINGS
Compression SSH_COMPRESSION
ConnectionAttempts SSH_CONNECTION_ATTEMPTS
ConnectTimeout SSH_CONNECT_TIMEOUT
ControlMaster SSH_CONTROL_MASTER
ControlPath SSH_CONTROL_PATH
ControlPersist SSH_CONTROL_PERSIST
DynamicForward SSH_DYNAMIC_FORWARD
EnableSSHKeysign SSH_ENABLE_SSH_KEYSIGN
EscapeChar SSH_ESCAPE_CHAR
ExitOnForwardFailure SSH_EXIT_ON_FORWARD_FAILURE
FingerprintHash SSH_FINGERPRINT_HASH
ForwardAgent SSH_FORWARD_AGENT
ForwardX11 SSH_FORWARD_X11
ForwardX11Timeout SSH_FORWARD_X11_TIMEOUT
ForwardX11Trusted SSH_FORWARD_X11_TRUSTED
GatewayPorts SSH_GATEWAY_PORTS
GlobalKnownHostsFile SSH_GLOBAL_KNOWN_HOSTS_FILE
GSSAPIAuthentication SSH_GSSAPI_AUTHENTICATION
GSSAPIDelegateCredentials SSH_GSSAPI_DELEGATE_CREDENTIALS
HashKnownHosts SSH_HASH_KNOWN_HOSTS
HostBasedAuthentication SSH_HOST_BASED_AUTHENTICATION
HostBasedKeyTypes SSH_HOST_BASED_KEY_TYPES
HostKeyAlgorithms SSH_HOST_KEY_ALGORITHMS
HostKeyAlias SSH_HOST_KEY_ALIAS
Hostname SSH_HOSTNAME
IdentitiesOnly SSH_IDENTITIES_ONLY
IdentityAgent SSH_IDENTITY_AGENT
IdentityFile SSH_IDENTITY_FILE
IgnoreUnknown SSH_IGNORE_UNKNOWN
Include SSH_INCLUDE
IPQoS SSH_IP_QOS
KbdInteractiveAuthentication SSH_KBD_INTERACTIVE_AUTHENTICATION
KbdInteractiveDevices SSH_KBD_INTERACTIVE_DEVICES
KexAlgorithms SSH_KEX_ALGORITHMS
LocalCommand SSH_LOCAL_COMMAND
LocalForward SSH_LOCAL_FORWARD
LogLevel SSH_LOG_LEVEL
MACs SSH_MACS
NoHostAuthenticationForLocalhost SSH_NO_HOST_AUTHENTICATION_FOR_LOCALHOST
NumberOfPasswordPrompts SSH_NUMBER_OF_PASSWORD_PROMPTS
PasswordAuthentication SSH_PASSWORD_AUTHENTICATION
PermitLocalCommand SSH_PERMIT_LOCAL_COMMAND
PKCS11Provider SSH_PKCS11_PROVIDER
Port SSH_PORT
PreferredAuthentications SSH_PREFERRED_AUTHENTICATIONS
ProxyCommand SSH_PROXY_COMMAND
ProxyJump SSH_PROXY_JUMP
ProxyUseFdPass SSH_PROXY_USE_FD_PASS
PubkeyAcceptedKeyTypes SSH_PUBKEY_ACCEPTED_KEY_TYPES
PubkeyAuthentication SSH_PUBKEY_AUTHENTICATION
RekeyLimit SSH_REKEY_LIMIT
RemoteCommand SSH_REMOTE_COMMAND
RemoteForward SSH_REMOTE_FORWARD
RequestTTY SSH_REQUEST_TTY
RevokedHostKeys SSH_REVOKED_HOST_KEYS
SecurityKeyProvider SSH_SECURITY_KEY_PROVIDER
SendEnv SSH_SEND_ENV
ServerAliveMaxCount SSH_SERVER_ALIVE_MAX_COUNT
ServerAliveInterval SSH_SERVER_ALIVE_INTERVAL
SetEnv SSH_SET_ENV
StreamLocalBindMask SSH_STREAM_LOCAL_BIND_MASK
StreamLocalBindUnlink SSH_STREAM_LOCAL_BIND_UNLINK
StrictHostKeyChecking SSH_STRICT_HOST_KEY_CHECKING
SyslogFacility SSH_SYSLOG_FACILITY
TCPKeepAlive SSH_TCP_KEEP_ALIVE
Tunnel SSH_TUNNEL
TunnelDevice SSH_TUNNEL_DEVICE
UpdateHostKeys SSH_UPDATE_HOST_KEYS
User SSH_USER
UserKnownHostsFile SSH_USER_KNOWN_HOSTS_FILE
VerifyHostKeyDNS SSH_VERIFY_HOST_KEY_DNS
VisualHostKey SSH_VISUAL_HOST_KEY
XAuthLocation SSH_X_AUTH_LOCATION

Example

ox-ssh-example.jpg

0 Open More issues
Closed

Allow output suffix to be customized

For my chezmoi dotfiles setup I don't want the exported file to have the .ssh_config suffix when I run org-ssh-export-to-config. This adds an elisp variable org-ssh-export-suffix that is used as the suffix and that defaults to .ssh_config.

opened Dec 27, 2020 by r0bobo 2
Closed

Autoloading usage of org-export-define-backend causing issues

Hi :wave: I started using this package and I love it!

I'm having an issue with the autoload cookie for usage of org-export-define-backend was added in this commit.

I was going to submit a PR to remove it, because for me when I generate my autoload file it gives me an error, because the function org-export-define-backend is not also autoloaded, so the definer fails when I load my autoloads.

I don't understand why it should to be autoloaded in the first place, so I'm asking why it's there and if there isn't a particular reason if it can be removed.

opened Dec 14, 2020 by ghost 2
Closed

Benefits over more traditional tangling

I think this looks neat and I'm happy to see it on Melpa, but I'm trying to understand the benefits over my existing workflow. Currently I manage my .ssh/config with all my dotfiles in a .dotfiles.org. The ssh section contains this:

* Shell
** ssh
:PROPERTIES:
:header-args:conf: :tangle ~/.ssh/config :mkdirp .ssh
:END:

*** Global
These apply to all hosts

#+BEGIN_SRC conf
Host *
     AddKeysToAgent yes
     ForwardX11 no
#+END_SRC

*** Host foo
Some comments about this host, etc.

#+BEGIN_SRC conf
Host foo
     User bar
     Hostname some.computer.com
     PermitLocalCommand yes
     LocalCommand konsoleprofile ColorScheme=ComputerDotComColorScheme
#+END_SRC

*** Hosts at bar
...

The major advantage of PROPERTY drawers is that they should be inherited by children (I think?) but that doesn't seem to be the case in your export. I would expect that vm-1 and vm-2 have SSH_PORT: 2222 set because they are children of proxmox.

opened Oct 18, 2020 by mankoff 2
Closed

Allow customizing ssh host alias to other things than org title

I want to name the title differently than what I want to appear as the host alias in the resulting ssh config in some cases. This adds the :HOST_OVERRIDE: property that takes precedence over the org title.

So for example:

* My Node
:PROPERTIES:
:IP: 192.168.1.1
:HOST_OVERRIDE: my-node
:END:

Will output:

Host my-node
  HostName 192.168.1.1
opened Dec 27, 2020 by r0bobo 0
Open

Idea: using hierarchy to specify ProxyJumps

Hello, thanks for this package, I'm loving it so far!

In the process of moving my ssh config, I noticed that I "naturally" used a pattern for machines that are available with a ProxyJump: I grouped them all under the header of the bastion host.

So, it got me thinking that if there's a host entry in a headline "below" another with a host entry, maybe ox-ssh should automatically add the ProxyJump specification when generating the config. Would that be interesting/feasible/useful?

opened Jan 6, 2021 by g5pw 0

Contents

    tonyaldon org-bars-mode is a minor mode for org-mode. It adds bars to the virtual indentation provided by the built-in package org-indent.
    net-ssh Pure Ruby implementation of an SSH (protocol 2) client
    dbrady A Tool to help manage your .ssh/config file.
    sshnet SSH.NET is a Secure Shell (SSH) library for .NET, optimized for parallelism.
    ssh-vault 🌰 encrypt/decrypt using ssh keys
    ccontavalli Different agents and different keys for different projects, with ssh.
    rougier An outer indentation org mode
    tonyaldon The documentation of https://clojurescript.org/ converted into a single org-mode file.
    fridgehead A bunch of useful SSH tools for powershell
    alirezat775 CarouselView for android with showing horizontal and vertical, auto scrolling (with pause/resume), slider mode/ carousel mode options
    AdamNiederer Vue Mode - Emacs major mode for vue.js.
    tonyaldon Clojure website in org-mode
    uber uber's ssh certificate pam module
    gliderlabs Easy SSH servers in Golang
    shazow Chat over SSH.
    TimothyYe A simple and powerful SSH keys manager
    ghoneycutt Puppet module to manage SSH
    ml-tooling 🐳 Dockerized SSH bastion to proxy SSH connections to arbitrary containers.
    sandoche πŸŒ“ Add a dark-mode / night-mode to your website in a few seconds
    ad-on-is A simple wrapper for ssh to select profiles.
    xwjdsh Manage your ssh alias configs easily.
    Share this repo

    Related Repos


    System utilities
    24
    Files used for reproducing Fuzzware's experiments
    fuzzware-fuzzer Fuzzware Experiments This directory contains the data required to reproduce the experiments from our USENIX 2022 publication Fuzzware: Using Precise M
     
    System utilities
    25
    Presentation plugin for neovim written in lua
    Chaitanyabsprip Presenting.nvim A Presentation plugin written for Neovim in Lua Installation You can install Present with your plugin manager of choice with packer.nv
     
    System utilities
    3
    Static analysis tool for Go that finds vulnerabilities using SSA (single static assignment...
    bryk-io GitHub Action: GoKart Security Static Analysis GoKart is a static analysis tool for Go that finds vulnerabilities using the SSA (single static assignm
     
    System utilities
    3
    Railway for Alist
    alist-org alist-railway Railway for Alist Usage Fork this repo Open Railway and click New Object Choose the repo that you forked and select the mysql branch Add
     
    System utilities
    19
    Basic Recon For Bug Bounty Hunter - "HuntTheBug" is Basic Scripts For Sub Domain Enumerati...
    vikrantbatra05 Basic Recon For Bug Bounty Hunter - "HuntTheBug" is Basic Scripts For Sub Domain Enumeration> Live Domain Enumeration > Sub Domain Hijack > URL + JavaScript Scan > Dir Brute Forcing > Open Port Check With Telegram Bot Notification
     
    System utilities
    84
    Extensible Neovim Scrollbar
    petertriho nvim-scrollbar Extensible Neovim Scrollbar 🚧 WORK IN PROGRESS 🚧 This is a work in progress and breaking changes to the setup/config could occur in t
     
    System utilities
    5
    😎😘 Free Windows 11 VPS for 4 Hours ! Easy Method!
    kmille36 Windows 11 RDP Here this tutorial using Azure Cloud Shell to create Virtual Machine on Microsoft Learn Sandbox. 😎 Its Four Hours RDP Completely Free
     
    System utilities
    3
    My configuraion files
    3Kevi Welcome! Here you can find my Void Linux dotfiles. Overview OS: Void Window manager: bspwm Terminal: kitty Shell: zsh Bar: Polybar Compositor: picom P
     
    System utilities
    3
    An especially small & quick & simple Algolia docsearch Indices upload action
    guzhongren algolia-docsearch-upload-action An especially small & quick & simple Algolia docsearch Indices upload action Usage - name: Algolia Docsearch Uploa
     
    System utilities
    35
    A simple and transparent alternative to boot2docker (backed by Vagrant)
    shyiko docker-vm The easiest way to get started with Docker on Mac OS X (tested on OS X Yosemite 10.10.1) and Windows (tested on Windows 10 Pro Insider Previ
     
    System utilities
    518
    GitOps powered K8s app suite with developer self-service
    redkubes Shift left with Otomi Otomi makes developers self-serving and helps DevOps teams to guarantee application security and availability at the earliest st
     
    System utilities
    102
    Awesome Bug bounty builder Project
    0xJin Awesome Bug Bounty Builder Β―\(ツ)/Β― Awesome Bug bounty builder Project - ALL common Tools for find your Vulnerabilities. Tested on Debian. Installation
     
    System utilities
    2
    Ready-to-use VSCode setup to preview/convert markdown documents
    logwolvy Ready-to-use VSCode setup to preview/convert markdown documents
     
    System utilities
    7.3k
    Testing TLS/SSL encryption anywhere on any port
    drwetter Testing TLS/SSL encryption anywhere on any port
     
    System utilities
    519
    Vegile - Ghost In The Shell
    Screetsec Vegile is a tool for Post exploitation Techniques in linux. Post Exploitation techniques will ensure that we maintain some level of access and can potentially lead to deeper footholds into our targets trusted network.