├── tests ├── .gitignore ├── pkg-install │ ├── .gitignore │ ├── PKG-INSTALL.rst │ ├── archive-contents │ ├── ssh-config-mode-pkg.el │ ├── test-pkg-install.el │ └── Makefile ├── authorized_keys ├── Makefile ├── config ├── ssh-config-test-helper-funcs.el └── known_hosts_short ├── .gitignore ├── Jenkinsfile.sh ├── get-keywords ├── Makefile └── get-keywords ├── .circleci └── config.yml ├── README.rst ├── ssh-config-keywords.txt ├── .github └── workflows │ ├── 10-run-tests.yml │ └── 30-update-ssh-keywords.yml ├── Makefile ├── ssh-config-mode.el └── COPYING /tests/.gitignore: -------------------------------------------------------------------------------- 1 | known_hosts 2 | -------------------------------------------------------------------------------- /tests/pkg-install/.gitignore: -------------------------------------------------------------------------------- 1 | *.tar 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.elc 2 | *.stderr 3 | *.stdout 4 | *.tmp 5 | *.xml 6 | *example* 7 | *~ 8 | \#*\# 9 | checkdoc-batch.el 10 | openssh-portable 11 | test-config* 12 | -------------------------------------------------------------------------------- /tests/authorized_keys: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/tests/authorized_keys --- 3 | # 4 | 5 | # good lines 6 | ssh-rsa AAbase64 7 | ssh-rsa AAbase64base64base64base64base64base64base64base64base64 comment 8 | ssh-rsa AAbase64base64base64base64base64base64base64base64== comment 9 | 10 | # bad (un-fonted) lines 11 | ssh-rsa 12 | ssh-rsa AAbase64base64base64==equalsinmiddle== comment 13 | -------------------------------------------------------------------------------- /tests/Makefile: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/tests/Makefile --- 3 | # 4 | 5 | SHELL:=/bin/bash 6 | .SUFFIXES: 7 | 8 | _default: ./known_hosts 9 | 10 | ##### 11 | 12 | # Grab a copy of known_hosts to test with. 13 | # The licences are different, so not checked in. 14 | ./known_hosts: 15 | cp \ 16 | ../get-keywords/openssh-portable/regress/unittests/hostkeys/testdata/known_hosts \ 17 | . 18 | 19 | -------------------------------------------------------------------------------- /tests/pkg-install/PKG-INSTALL.rst: -------------------------------------------------------------------------------- 1 | ssh-config-mode-el/tests/pkg-install/PKG-INSTALL 2 | ================================================== 3 | 4 | When installing non-interactively, there was an error reported. 5 | 6 | - https://github.com/jhgorrell/ssh-config-mode-el/issues/19 7 | 8 | Using docker is kinda overkill, but lets roll with it. This 9 | will ensure the test isnt picking up anything from the 10 | native environment. 11 | -------------------------------------------------------------------------------- /tests/pkg-install/archive-contents: -------------------------------------------------------------------------------- 1 | (1 2 | (ssh-config-mode 3 | . 4 | [(99998877 1234) nil 5 | "Mode for fontification of ~/.ssh/config" tar 6 | ((:commit . "e9f009c064f63ca488c89c30ab0d3857a0155f86") 7 | (:keywords "ssh" "config" "emacs") 8 | (:authors ("Harley Gorrell" . "harley@panix.com")) 9 | (:maintainer "Harley Gorrell" . "harley@panix.com") 10 | (:url . "https://github.com/jhgorrell/ssh-config-mode-el"))]) 11 | ) 12 | -------------------------------------------------------------------------------- /tests/config: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/tests/config --- 3 | # 4 | # (load-file "./ssh-config-test-helper-funcs.el") 5 | 6 | Host a.example.com a 7 | HostName 1.2.3.1 8 | ForwardAgent yes 9 | 10 | Host b.example.com b 11 | HostName 1.2.3.2 12 | ForwardAgent yes 13 | 14 | Host c.example.com c 15 | HostName 1.2.3.4 16 | ForwardAgent yes 17 | ForwardAgent yes 18 | ForwardX11 yes 19 | LogLevel DEBUG 20 | 21 | # Local Variables: 22 | # mode: ssh-config 23 | # End: 24 | -------------------------------------------------------------------------------- /tests/pkg-install/ssh-config-mode-pkg.el: -------------------------------------------------------------------------------- 1 | ;; 2 | ;; ssh-config-mode-el/tests/pkg-install/ssh-config-mode-pkg.el --- 3 | ;; 4 | ;; Fake package entry for testing. 5 | ;; 6 | (define-package 7 | "ssh-config-mode" 8 | "99998877.1234" 9 | "Mode for fontification of ~/.ssh/config" 10 | 'nil 11 | :keywords '("ssh" "config" "emacs") 12 | :authors '(("Harley Gorrell" . "harley@panix.com")) 13 | :maintainer '("Harley Gorrell" . "harley@panix.com") 14 | :url "https://github.com/jhgorrell/ssh-config-mode-el") 15 | ;; Local Variables: 16 | ;; no-byte-compile: t 17 | ;; End: 18 | -------------------------------------------------------------------------------- /tests/pkg-install/test-pkg-install.el: -------------------------------------------------------------------------------- 1 | ;; 2 | ;; ssh-config-mode-el/tests/pkg-install/test-init.el --- 3 | ;; 4 | 5 | (require 'package) 6 | 7 | ;; When you run this you are testing the pubished version, 8 | ;; not the one in this directory. 9 | ;;(add-to-list 10 | ;; 'package-archives 11 | ;; '("melpa" . "https://melpa.org/packages/") t) 12 | 13 | ;; Add this directory as the only archive. 14 | (setq 15 | package-archives 16 | (list 17 | (cons "bogus" (getenv "PWD")))) 18 | 19 | (setq 20 | package-unsigned-archives 21 | (list "bogus")) 22 | 23 | (package-initialize) 24 | (package-refresh-contents) 25 | 26 | (setq debug-on-error t) 27 | 28 | (package-install 'ssh-config-mode) 29 | 30 | ;;(package-list-packages) 31 | -------------------------------------------------------------------------------- /tests/ssh-config-test-helper-funcs.el: -------------------------------------------------------------------------------- 1 | ;; 2 | ;; ssh-config-mode-el/tests/ssh-config-test-helper-funcs.el --- 3 | ;; 4 | ;; (load-file "ssh-config-test-helper-funcs.el") 5 | 6 | (defun ssh-known-hosts-mode-reload () 7 | "A helper for testing ssh-known-hosts-mode in a buffer. 8 | Reeval the ssh-config mode and reenable it." 9 | (interactive) 10 | ;; in case we crash 11 | (save-some-buffers) 12 | ;; clean out old values 13 | (dolist 14 | (x 15 | '( 16 | ssh-known-hosts-font-lock-keywords 17 | ssh-known-hosts-regex-hashed 18 | ssh-known-hosts-regex-host 19 | ssh-known-hosts-regex-hostname 20 | ssh-known-hosts-regex-ip 21 | ssh-known-hosts-regex-ipv4 22 | ssh-known-hosts-regex-ipv6 23 | ssh-known-hosts-regex-port)) 24 | (makunbound x)) 25 | ;; reload the code. 26 | (let ((buf (get-buffer "ssh-config-mode.el"))) 27 | (eval-buffer buf)) 28 | ;; reenable the mode. 29 | (fundamental-mode) 30 | (font-lock-mode 0) 31 | (ssh-known-hosts-mode) 32 | (font-lock-fontify-buffer)) 33 | -------------------------------------------------------------------------------- /Jenkinsfile.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # ssh-config-mode-el/Jenkinsfile.sh --- 4 | # 5 | 6 | # Regenerates "ssh-config-keywords.txt" from the checked out openssh. 7 | 8 | if ! make _update_keywords 9 | then 10 | echo "### update keywords failed." 11 | exit 1 12 | fi 13 | 14 | if [[ ! -d get-keywords/openssh-portable ]] 15 | then 16 | echo "### update_keywords failed." 17 | exit 1 18 | fi 19 | 20 | # 21 | openssh_git_id=$(cd get-keywords/openssh-portable ; \ 22 | git describe --always --dirty --long --tags) 23 | echo "### openssh_git_id: ${openssh_git_id}" 24 | 25 | if [[ "${openssh_git_id}" = "" ]] 26 | then 27 | echo "### openssh_git_id failed." 28 | exit 1 29 | fi 30 | 31 | if git diff --exit-code --name-only ssh-config-keywords.txt 32 | then 33 | echo "### no changes to 'ssh-config-keywords.txt'" 34 | else 35 | echo "### ssh-config-keywords.txt: updating to ${openssh_git_id}" 36 | git commit -a -m "ssh-config-keywords.txt: updated to ${openssh_git_id}" 37 | git push origin HEAD:master 38 | # 39 | git tag -f "${openssh_git_id}" 40 | git push origin "${openssh_git_id}" 41 | # 42 | echo "### update complete..." 43 | fi 44 | -------------------------------------------------------------------------------- /get-keywords/Makefile: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/gen-keywords/Makefile --- 3 | # 4 | 5 | SHELL:=bash 6 | 7 | _default: _update_keywords 8 | 9 | ##### 10 | 11 | ifeq (${GITHUB_ACTIONS},) 12 | # use ssh for humans... 13 | openssh_portable_url:="git@github.com:openssh/openssh-portable.git" 14 | else 15 | # ...https for robots 16 | openssh_portable_url:=https://github.com/openssh/openssh-portable.git 17 | endif 18 | 19 | openssh-portable: 20 | git clone ${openssh_portable_url} ${@} 21 | 22 | # Get the latest tagged version. 23 | _update_openssh: | openssh-portable 24 | cd openssh-portable && \ 25 | git config advice.detachedHead false && \ 26 | git fetch && \ 27 | git checkout $(git describe --tags $(git rev-list --tags --max-count=1)) 28 | 29 | _get_keywords: | openssh-portable 30 | # 31 | rm -f ./keywords.txt 32 | # 33 | ./get-keywords \ 34 | --output-file ./keywords.txt \ 35 | ./openssh-portable/readconf.c 36 | mv keywords.txt ../ssh-config-keywords.txt 37 | 38 | _update_keywords: _update_openssh _get_keywords 39 | 40 | ##### 41 | 42 | _get_keywords_debug: 43 | ./get-keywords \ 44 | --debug \ 45 | ./openssh-portable/readconf.c 46 | -------------------------------------------------------------------------------- /tests/pkg-install/Makefile: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/tests/pkg-install/Makefile --- 3 | # 4 | 5 | SHELL:=/bin/bash 6 | .SUFFIXES: 7 | 8 | _default: _test_pkg_install 9 | 10 | ##### 11 | 12 | # Took the package setup and definitions from here and modfied them: 13 | # - wget http://www.melpa.org/packages/archive-contents 14 | # - wget http://www.melpa.org/packages/ssh-config-mode-20191221.1051.tar 15 | 16 | # use "gtar" if found (for OSX) 17 | tar_exe=$(word 1,$(shell type -p gtar) $(shell type -p tar)) 18 | 19 | # This is our bogus package for testing. 20 | scm_name:=ssh-config-mode-99998877.1234 21 | scm_tar:=./${scm_name}.tar 22 | 23 | ${scm_tar}: Makefile \ 24 | ssh-config-mode-pkg.el \ 25 | ../../ssh-config-mode.el \ 26 | ../../ssh-config-keywords.txt 27 | # 28 | ${tar_exe} -cv \ 29 | --transform 's,^\.,${scm_name},' \ 30 | -f ${@} \ 31 | ./ssh-config-mode-pkg.el \ 32 | -C ../.. \ 33 | ./ssh-config-mode.el \ 34 | ./ssh-config-keywords.txt 35 | # 36 | tar -tf ${@} 37 | 38 | _build_tar: ${scm_tar} 39 | 40 | _test_pkg_install: ${scm_tar} 41 | # remove the existing install 42 | rm -rf ~/.emacs.d/elpa/ssh-config-mode-* 43 | # install ssh-config-mode non-interactively 44 | emacs --batch -Q -l test-pkg-install.el 45 | -------------------------------------------------------------------------------- /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | jobs: 3 | build: 4 | docker: 5 | - image: ubuntu:20.04 6 | 7 | steps: 8 | 9 | # prep the system 10 | - restore_cache: 11 | keys: 12 | - "v1-apt" 13 | 14 | - run: 15 | name: "apt-get update" 16 | command: "DEBIAN_FRONTEND=noninteractive apt-get update" 17 | - run: 18 | name: "apt-get install" 19 | command: "DEBIAN_FRONTEND=noninteractive apt-get install -y ca-certificates emacs-nox make wget ssh git curl" 20 | 21 | - restore_cache: 22 | keys: 23 | - "v1-dot-git" 24 | 25 | - checkout 26 | 27 | - restore_cache: 28 | keys: 29 | - "v1-checkdoc-batch-el" 30 | 31 | - run: 32 | name: "make" 33 | command: "make _circleci_run" 34 | 35 | - store_artifacts: 36 | path: "checkdoc.stderr" 37 | - store_artifacts: 38 | path: "checkdoc.stdout" 39 | - store_artifacts: 40 | path: "junit.xml" 41 | 42 | # save a bunch of stuff. 43 | - save_cache: 44 | key: "v1-apt" 45 | paths: 46 | - "/var/cache/apt/archives" 47 | - save_cache: 48 | key: "v1-dot-git" 49 | paths: 50 | - ".git" 51 | - save_cache: 52 | key: "v1-checkdoc-batch-el" 53 | paths: 54 | - "checkdoc-batch.el" 55 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ssh-config-mode-el/README 2 | ================================================== 3 | 4 | .. image:: https://melpa.org/packages/ssh-config-mode-badge.svg 5 | :target: https://melpa.org/#/ssh-config-mode 6 | 7 | .. image:: https://github.com/peterhoeg/ssh-config-mode-el/actions/workflows/10-run-tests.yml/badge.svg 8 | :target: https://github.com/peterhoeg/ssh-config-mode-el/actions/workflows/10-run-tests.yml 9 | 10 | A mode to edit SSH config files. 11 | 12 | It does the following: 13 | 14 | - Fontifys the SSH config keywords. 15 | - Keys for skipping from host section to host section. 16 | - Indentation of configuration found in the following locations: 17 | 18 | :: 19 | 20 | .ssh/config 21 | sshd?_config 22 | known_hosts 23 | authorized_keys2? 24 | 25 | If you have a SSH config file that you'd like to use this 26 | mode on automatically, add this line as the first one in the file: 27 | 28 | :: 29 | 30 | # -*- mode: ssh-config -*- 31 | 32 | Or add somthing like this to your init file: 33 | 34 | :: 35 | 36 | (add-to-list 'auto-mode-alist '("/path-to-your-ssh/config\\'" . ssh-config-mode)) 37 | 38 | Links 39 | ---------------------------------------- 40 | 41 | - https://github.com/peterhoeg/ssh-config-mode-el 42 | - https://github.com/openssh/openssh-portable 43 | 44 | 45 | License 46 | ---------------------------------------- 47 | 48 | ``ssh-config-mode-el`` is distributed under the 49 | `GPL-3.0 `_ 50 | (or any later version.) 51 | 52 | Contributors 53 | -------------------------------------------------- 54 | 55 | - Harley Gorrell 56 | - John Mastro 57 | - Masahiro Hayashi 58 | - Matthew Weaver 59 | - Sharif Nassar 60 | - Ted Carnahan 61 | - USAMI Kenta 62 | - Wieland Hoffmann 63 | - iory 64 | - Александар Симић 65 | - Andrew Schwartzmeyer 66 | - Eder Elorriaga 67 | - Ville Skyttä 68 | -------------------------------------------------------------------------------- /ssh-config-keywords.txt: -------------------------------------------------------------------------------- 1 | addkeystoagent 2 | addressfamily 3 | batchmode 4 | bindaddress 5 | bindinterface 6 | canonicaldomains 7 | canonicalizefallbacklocal 8 | canonicalizehostname 9 | canonicalizemaxdots 10 | canonicalizepermittedcnames 11 | casignaturealgorithms 12 | certificatefile 13 | challengeresponseauthentication 14 | channeltimeout 15 | checkhostip 16 | ciphers 17 | clearallforwardings 18 | compression 19 | connectionattempts 20 | connecttimeout 21 | controlmaster 22 | controlpath 23 | controlpersist 24 | dsaauthentication 25 | dynamicforward 26 | enableescapecommandline 27 | enablesshkeysign 28 | escapechar 29 | exitonforwardfailure 30 | fingerprinthash 31 | forkafterauthentication 32 | forwardagent 33 | forwardx11 34 | forwardx11timeout 35 | forwardx11trusted 36 | gatewayports 37 | globalknownhostsfile 38 | gssapiauthentication 39 | gssapidelegatecredentials 40 | hashknownhosts 41 | host 42 | hostbasedacceptedalgorithms 43 | hostbasedauthentication 44 | hostbasedkeytypes 45 | hostkeyalgorithms 46 | hostkeyalias 47 | hostname 48 | identitiesonly 49 | identityagent 50 | identityfile 51 | identityfile2 52 | ignoreunknown 53 | include 54 | ipqos 55 | kbdinteractiveauthentication 56 | kbdinteractivedevices 57 | keepalive 58 | kexalgorithms 59 | knownhostscommand 60 | localcommand 61 | localforward 62 | loglevel 63 | logverbose 64 | macs 65 | match 66 | nohostauthenticationforlocalhost 67 | numberofpasswordprompts 68 | obscurekeystroketiming 69 | passwordauthentication 70 | permitlocalcommand 71 | permitremoteopen 72 | pkcs11provider 73 | port 74 | preferredauthentications 75 | protocol 76 | proxycommand 77 | proxyjump 78 | proxyusefdpass 79 | pubkeyacceptedalgorithms 80 | pubkeyacceptedkeytypes 81 | pubkeyauthentication 82 | rekeylimit 83 | remotecommand 84 | remoteforward 85 | requesttty 86 | requiredrsasize 87 | revokedhostkeys 88 | securitykeyprovider 89 | sendenv 90 | serveralivecountmax 91 | serveraliveinterval 92 | sessiontype 93 | setenv 94 | skeyauthentication 95 | smartcarddevice 96 | stdinnull 97 | streamlocalbindmask 98 | streamlocalbindunlink 99 | stricthostkeychecking 100 | syslogfacility 101 | tag 102 | tcpkeepalive 103 | tisauthentication 104 | tunnel 105 | tunneldevice 106 | updatehostkeys 107 | usekeychain 108 | user 109 | userknownhostsfile 110 | verifyhostkeydns 111 | versionaddendum 112 | visualhostkey 113 | xauthlocation 114 | -------------------------------------------------------------------------------- /.github/workflows/10-run-tests.yml: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/.github/workflows/10-run-tests.yml --- 3 | # 4 | # Runs our (very simple) tests. 5 | 6 | name: 10-run-tests 7 | on: 8 | - push 9 | 10 | defaults: 11 | run: 12 | shell: bash 13 | 14 | env: 15 | DEBIAN_FRONTEND: noninteractive 16 | 17 | jobs: 18 | 19 | run-tests: 20 | runs-on: ubuntu-latest 21 | 22 | steps: 23 | 24 | - name: Git checkout 25 | uses: actions/checkout@v2 26 | 27 | # The cache unpacking runs as the user, allow us to write. 28 | - name: Chmod /var/cache/apt/archives 29 | run: | 30 | sudo chmod a+w /var/cache/apt/archives/. 31 | 32 | - name: Cache apt pkgs 33 | id: cache-apt-pkgs 34 | uses: actions/cache@v2 35 | with: 36 | key: cache-apt-pkgs 37 | restore-keys: | 38 | cache-apt-pkgs 39 | path: | 40 | /var/cache/apt/archives/*.deb 41 | 42 | - name: apt-get install 43 | run: | 44 | sudo apt-get update 45 | sudo apt-get install -y \ 46 | ca-certificates \ 47 | curl \ 48 | emacs-nox \ 49 | git \ 50 | make \ 51 | ssh \ 52 | wget 53 | 54 | - name: Cache checkdoc 55 | id: cache-checkdoc-batch 56 | uses: actions/cache@v2 57 | with: 58 | key: cache-checkdoc-batch 59 | path: | 60 | ./checkdoc-batch.el 61 | 62 | - name: Fetch checkdoc-batch.el 63 | if: steps.cache-checkdoc-batch.outputs.cache-hit != 'true' 64 | run: | 65 | make checkdoc-batch.el 66 | 67 | - name: Run tests 68 | run: | 69 | cd ${GITHUB_WORKSPACE} 70 | make _circleci_run 71 | 72 | - name: Date 73 | id: date 74 | run: | 75 | echo "::set-output name=date::$(date +%Y%m%dT%H%M)" 76 | 77 | # Currently we have to download the zip to see them. 78 | # This might change in the future. 79 | # https://github.com/actions/upload-artifact/issues/14 80 | - name: Artifacts 81 | uses: actions/upload-artifact@v2 82 | if: ${{ always() }} 83 | with: 84 | name: ssh-config-mode-el-artifacts-${{ github.run_number }}-${{steps.date.outputs.date}} 85 | if-no-files-found: error 86 | path: | 87 | checkdoc.stderr 88 | checkdoc.stdout 89 | junit.xml 90 | -------------------------------------------------------------------------------- /.github/workflows/30-update-ssh-keywords.yml: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/.github/workflows/30-update-ssh-keywords.yml --- 3 | # 4 | 5 | name: 30-update-ssh-keywords 6 | on: 7 | # once a month. 8 | schedule: 9 | # mm hh dom mon dow (no H, like jenkins) 10 | - cron: '0 0 1 * *' 11 | # 12 | workflow_dispatch: 13 | 14 | defaults: 15 | run: 16 | shell: bash 17 | 18 | jobs: 19 | 20 | update-ssh-keywords: 21 | runs-on: ubuntu-latest 22 | 23 | steps: 24 | 25 | - name: Git checkout 26 | uses: actions/checkout@v2 27 | 28 | # The cache unpacking runs as the user, allow us to write. 29 | - name: Chmod /var/cache/apt/archives 30 | run: | 31 | sudo chmod a+w /var/cache/apt/archives/. 32 | 33 | - name: Cache apt pkgs 34 | id: cache-apt-pkgs 35 | uses: actions/cache@v2 36 | with: 37 | key: cache-apt-pkgs 38 | # -${{ github.sha }} 39 | restore-keys: | 40 | cache-apt-pkgs 41 | path: | 42 | /var/cache/apt/archives/*.deb 43 | 44 | - name: apt-get install 45 | run: | 46 | sudo apt-get update 47 | sudo apt-get install -y \ 48 | ca-certificates \ 49 | git \ 50 | make 51 | 52 | - name: Cache openssh-portable 53 | id: cache-openssh-portable 54 | uses: actions/cache@v2 55 | with: 56 | key: cache-openssh-portable 57 | restore-keys: | 58 | cache-openssh-portable 59 | path: | 60 | ${{github.workspace}}/get-keywords/openssh-portable 61 | 62 | - name: Checkout openssh 63 | id: openssh 64 | run: | 65 | cd ${GITHUB_WORKSPACE}/get-keywords 66 | make _update_openssh 67 | cd ${GITHUB_WORKSPACE}/get-keywords/openssh-portable 68 | echo "::set-output name=tag::$(git describe --tags)" 69 | 70 | - name: Update keywords 71 | run: | 72 | cd ${GITHUB_WORKSPACE}/get-keywords 73 | make _update_keywords 74 | 75 | - name: Create PR 76 | uses: peter-evans/create-pull-request@v3 77 | with: 78 | commit-message: Update ssh keywords to ${{steps.openssh.outputs.tag}} 79 | committer: 30-update-ssh-keywords 80 | author: ${{github.actor}} <${{github.actor}}@noreply> 81 | branch: 30-update-ssh-keywords 82 | delete-branch: true 83 | body: | 84 | Update ssh keywords to ${{steps.openssh.outputs.tag}} 85 | assignees: jhgorrell 86 | reviewers: jhgorrell 87 | -------------------------------------------------------------------------------- /tests/known_hosts_short: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/tests/known_hosts_short --- 3 | # 4 | # Short known_hosts file for testing. 5 | # 6 | # (load-file "./ssh-config-test-helper-funcs.el") 7 | # (ssh-known-hosts-mode-reload) 8 | # 9 | 10 | ##### good lines. (all should be fontified) 11 | 12 | localhost ssh-rsa AAAABBBBCCCC/+DDDD 13 | host.example.com ssh-rsa AAAABBBBCCCC/+DDDD 14 | host.example.com,1.1.1.1 ecdsa-sha2-nistp384 AAAABBBBCCCC/+DDDD== 15 | host.example.com,1234::abcd ssh-rsa AAAABBBBCCCC/+DDDD extra-data # comment 16 | |1|abcd/+efghijk=|lmnopqr/+stuxyz= ssh-rsa AAAABBBBCCCC/+DDDD 17 | @revoked host.example.com ssh-rsa AAAABBBBCCCC/+DDDD 18 | @cert-authority host.example.com ssh-rsa AAAABBBBCCCC/+DDDD 19 | laptop.local,fe80::1234:4567%en0 ecdsa-sha2-nistp384 AAAABBBBCCCC/+DDDD 20 | [localhost]:22222 ssh-rsa AAAABBBBCCCC/+DDDD 21 | [ssh.github.com]:443,[192.1.2.3]:443 ssh-rsa AAAABBBBCCCC/+DDDD== 22 | # single character hostnames. 23 | a.z.github.com ssh-rsa AAAABBBBCCCCDDDD 24 | [a.z.github.com]:443,[192.1.2.3]:443 ssh-rsa AAAABBBBCCCCDDDD 25 | 26 | # ipv6 27 | fe80::3285:a9ff:fea7:6de3 ecdsa-sha2-nistp AAAABBBCCCCDDDD 28 | fe80::3285:a9ff:fea7:6de3%en0 ecdsa-sha2-nistp AAAABBBCCCCDDDD 29 | [fe80::3285:a9ff:fea7:6de3]:2222 ecdsa-sha2-nistp AAAABBBCCCCDDDD 30 | # ipv4 with port 31 | [136.24.83.19]:2222 ssh-rsa AAAABBBCCCCDDDD 32 | 33 | ##### bad lines (none should be fontified) 34 | 35 | @revoked 36 | @revoked xx 37 | bad.line.com 38 | @whoa! host.example.com ssh-rsa AAAABBBBCCCCDDDD 39 | 40 | # foo-rsa 41 | bad.line.com foo-rsa AAAABBBBCCCCDDDD 42 | bad.line.com ssh-foo AAAABBBBCC==equalsinmiddle== 43 | 44 | # messed up ipv4 45 | 1.2.3 ssh-foo AAAABBBBCCC 46 | 1.2.3. ssh-foo AAAABBBBCCC 47 | 1.2.3.4. ssh-foo AAAABBBBCCC 48 | 49 | # ip-then-host 50 | 1.2.3.4,host.example.com ssh-foo AAAABBBBCCC 51 | 52 | # ipv4 with port misformatted 53 | [136.24.83.19] ssh-rsa AAAABBBCCCCDDDD 54 | # partial-ipv4 55 | [24.83.19]:222 ssh-rsa AAAABBBCCCCDDDD 56 | 57 | # bad hashes 58 | ||abcdefghijk=|lmnopqrstuxyz= ssh-rsa AAAABBBBCCCCDDDD 59 | 1|abcdefghijk=|lmnopqrstuxyz= ssh-rsa AAAABBBBCCCCDDDD 60 | 61 | # pair with items missing 62 | []:443,[192.1.2.3]:443 ssh-rsa AAAABBBBCCCCDDDD 63 | [ssh.github.com]:443,[]:443 ssh-rsa AAAABBBBCCCCDDDD 64 | # pair with port missing 65 | [ssh.github.com]:,[192.1.2.3]:443 ssh-rsa AAAABBBBCCCCDDDD 66 | [ssh.github.com]:443,[192.1.2.3]: ssh-rsa AAAABBBBCCCCDDDD 67 | 68 | # extra space 69 | [ssh.github.com]:443, [192.1.2.3]:443 ssh-rsa AAAABBBBCCCCDDDD 70 | [ssh.github.com]:443 ,[192.1.2.3]:443 ssh-rsa AAAABBBBCCCCDDDD 71 | 72 | # bad ipv6 73 | zzzzz%abc ssh-rsa AAAABBBCCCCDDDD 74 | # spaces 75 | [fe80::3285:a9ff :fea7:6de3]:2222 ecdsa-sha2-nistp AAAABBBCCCCDDDD 76 | # missing leading "[" 77 | fe80::3285:a9ff:fea7:6de3]:2222 ecdsa-sha2-nistp AAAABBBCCCCDDDD 78 | 79 | # Local Variables: 80 | # mode: ssh-known-hosts 81 | # End: 82 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # 2 | # ssh-config-mode-el/Makefile --- 3 | # 4 | 5 | SHELL:=bash 6 | .SUFFIXES: 7 | 8 | _default: _byte_compile 9 | 10 | ##### 11 | 12 | # figure you will have emacs already... =) 13 | _brew_install: 14 | brew install \ 15 | gnu-tar \ 16 | python3 17 | 18 | ##### 19 | 20 | EL:=ssh-config-mode.el 21 | 22 | _byte_compile: 23 | -rm *.elc 24 | emacs \ 25 | --batch \ 26 | --eval "(add-to-list 'load-path \"${PWD}\")" \ 27 | --funcall batch-byte-compile \ 28 | ${EL} 29 | 30 | checkdoc-batch.el: 31 | wget -O ${@}.tmp http://download.tuxfamily.org/user42/${@} 32 | mv ${@}.tmp ${@} 33 | 34 | _checkdoc_batch: | checkdoc-batch.el 35 | emacs --batch \ 36 | --load ${PWD}/checkdoc-batch.el \ 37 | --funcall checkdoc-batch-commandline \ 38 | ${EL} 1> checkdoc.stdout 2> checkdoc.stderr ; \ 39 | cat checkdoc.stdout checkdoc.stderr 40 | 41 | ### 42 | 43 | _update_keywords: 44 | cd get-keywords && make _update_keywords 45 | 46 | _jenkinsfile_sh: 47 | ./Jenkinsfile.sh 48 | 49 | ### 50 | 51 | # Will need to edit this 52 | _contributors: 53 | @git log --format='- %an' HEAD^@ | \ 54 | sort | \ 55 | grep -v -e 'harley gorrell' -e 'jenkins-bot' -e 'jhgorrell' | \ 56 | uniq 57 | 58 | ### 59 | 60 | _clean: 61 | -rm *.elc junit.xml junit.xml.tmp 62 | 63 | _dist_clean: _clean 64 | -rm checkdoc-batch.el 65 | 66 | ### 67 | 68 | _test_pkg_install: 69 | cd tests/pkg-install && make ${@} 70 | 71 | ### 72 | 73 | NEW_TAG ?= $(shell date +%Y%m%dT%H%M) 74 | 75 | _update_tag: 76 | echo "### Tagging as: '$(NEW_TAG)'..." 77 | sed -i "" -e 's/^;; Tag: .*/;; Tag: $(NEW_TAG)/' $(EL) 78 | git commit -am "set tag to: '$(NEW_TAG)'" 79 | git tag -f $(NEW_TAG) 80 | 81 | ### 82 | 83 | python_files+=./get-keywords/get-keywords 84 | 85 | _isort: 86 | isort \ 87 | --multi-line 3 \ 88 | --trailing-comma \ 89 | --line-width 1 \ 90 | ${python_files} 91 | 92 | _autopep8: 93 | autopep8 \ 94 | --aggressive \ 95 | --in-place \ 96 | --max-line-length 120 \ 97 | ${python_files} 98 | 99 | _precommit+=_isort 100 | _precommit+=_autopep8 101 | _precommit+=_byte_compile 102 | _precommit+=_test_pkg_install 103 | _precommit+=_checkdoc_batch 104 | 105 | _precommit: ${_precommit} 106 | 107 | ### 108 | 109 | _emacs_version: 110 | emacs --version 111 | 112 | _printenv: 113 | printenv | sort 114 | 115 | junit=@echo -e ${1} >> junit.xml.tmp 116 | 117 | # Fake a successful run. 118 | _circleci_junit_ok: _checkdoc_batch 119 | @echo -n "" > junit.xml.tmp 120 | @$(call junit,"") 121 | @$(call junit,"\n") 122 | @$(call junit,"") 123 | @cat checkdoc.stdout >> junit.xml.tmp 124 | @$(call junit,-e "\n") 125 | @cat checkdoc.stderr >> junit.xml.tmp 126 | @$(call junit,"\n\n") 127 | mv junit.xml.tmp junit.xml 128 | 129 | _circleci_run+=_clean 130 | _circleci_run+=_printenv 131 | _circleci_run+=_emacs_version 132 | _circleci_run+=_byte_compile 133 | _circleci_run+=_test_pkg_install 134 | _circleci_run+=_circleci_junit_ok 135 | 136 | _circleci_run: ${_circleci_run} 137 | -------------------------------------------------------------------------------- /get-keywords/get-keywords: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # 3 | # ssh-config-mode-el/get-keywords/get-keywords --- 4 | # 5 | # Extracts the list of keywords from "readconf.c" 6 | # 7 | # A better method would be to compile "readconf.c" 8 | # into a python module and then grab the list from that. 9 | # Using a regex works well enough for now. 10 | 11 | from __future__ import ( 12 | absolute_import, 13 | division, 14 | print_function, 15 | unicode_literals, 16 | ) 17 | 18 | import argparse 19 | import os 20 | import pdb 21 | import re 22 | import sys 23 | 24 | ##### 25 | 26 | DEBUG = None 27 | VERBOSE = None 28 | VERSION = '' 29 | 30 | ##### 31 | 32 | # We want to match lines which look like this: 33 | # 34 | # { "userknownhostsfile2", oDeprecated }, 35 | # { "gssapiauthentication", oGssAuthentication }, 36 | # 37 | # Skip the "oDeprecated" ones, but keep "oUnsupported". 38 | # As they are still active, but compile time options. 39 | 40 | #: Regex to match conf options from "readconf.c" 41 | KEYWORD_RE = re.compile( 42 | " *{ *\"(?P[a-z0-9]+)\" *, *(?Po[a-z0-9]*) *}", 43 | re.IGNORECASE) 44 | 45 | #: List of opcodes which shouldnt be included in the keyword list. 46 | OPCODES_IGNORE = [ 47 | "oDeprecated", 48 | "oUnsupported", 49 | ] 50 | 51 | 52 | def main(raw_args): 53 | global DEBUG, VERBOSE, VERSION 54 | # 55 | parser = argparse.ArgumentParser(formatter_class=argparse.RawTextHelpFormatter) 56 | parser.description = """ 57 | DESCRIPTION: 58 | 59 | """ 60 | parser.epilog = """ 61 | EXAMPLES: 62 | 63 | """ 64 | # 65 | g = parser.add_argument_group('GENERAL') 66 | g.add_argument("--debug", "-d", 67 | action="store_true", 68 | help=argparse.SUPPRESS) 69 | g.add_argument("--pdb", 70 | action="store_true", 71 | help=argparse.SUPPRESS) 72 | g.add_argument("--verbose", "-v", 73 | action="store_true", 74 | help="Be more verbose.") 75 | g.add_argument("--output-file", "-o", 76 | help="Write output") 77 | 78 | # 79 | g = parser.add_argument_group('ARGS') 80 | g.add_argument("args", nargs="*", 81 | help="The remaining args.") 82 | 83 | # 84 | args = parser.parse_args(raw_args) 85 | # 86 | if args.pdb: 87 | pdb.set_trace() 88 | if args.debug: 89 | DEBUG = args.debug 90 | if args.verbose: 91 | VERBOSE = args.verbose 92 | 93 | # 94 | keyword_set = set(['usekeychain']) 95 | 96 | # 97 | for arg in args.args: 98 | for line in open(arg).readlines(): 99 | for m in KEYWORD_RE.finditer(line): 100 | # 101 | if DEBUG: 102 | print(" {!r} = {!r}".format(m.group("name"), m.group("opcode"))) 103 | # skip old options 104 | if m.group("opcode") in OPCODES_IGNORE: 105 | continue 106 | # 107 | keyword_set.add(m.group("name")) 108 | 109 | # 110 | if args.output_file: 111 | with open(args.output_file, "w") as fh: 112 | fh.write("\n".join(sorted(keyword_set)) + "\n") 113 | else: 114 | print("\n".join(sorted(keyword_set))) 115 | 116 | 117 | # 118 | if __name__ == "__main__": 119 | sys.exit(main(sys.argv[1:])) 120 | 121 | # Local Variables: 122 | # mode: python 123 | # End: 124 | -------------------------------------------------------------------------------- /ssh-config-mode.el: -------------------------------------------------------------------------------- 1 | ;;; ssh-config-mode.el --- Mode for fontification of ~/.ssh/config 2 | 3 | ;; SPDX-License-Identifier: GPL-3.0-or-later 4 | ;; Author: Harley Gorrell 5 | ;; Maintainer: Peter Hoeg 6 | ;; URL: https://github.com/peterhoeg/ssh-config-mode-el 7 | ;; Github: https://raw.github.com/peterhoeg/ssh-config-mode-el/master/ssh-config-mode.el 8 | ;; Keywords: comm, files 9 | ;; Version: 1.14 10 | ;; Package-Requires: ((emacs "24.3")) 11 | 12 | ;;; Commentary: 13 | ;; * Fontifys the ssh config keywords. 14 | ;; * keys for skipping from host section to host section. 15 | ;; * Add the following to your startup file. 16 | ;; (autoload 'ssh-config-mode "ssh-config-mode" t) 17 | ;; (add-to-list 'auto-mode-alist '("/\\.ssh/config\\(\\.d/.*\\.conf\\)?\\'" . ssh-config-mode)) 18 | ;; (add-to-list 'auto-mode-alist '("/sshd?_config\\(\\.d/.*\\.conf\\)?\\'" . ssh-config-mode)) 19 | ;; (add-to-list 'auto-mode-alist '("/known_hosts\\'" . ssh-known-hosts-mode)) 20 | ;; (add-to-list 'auto-mode-alist '("/authorized_keys2?\\'" . ssh-authorized-keys-mode)) 21 | ;; (add-hook 'ssh-config-mode-hook 'turn-on-font-lock) 22 | 23 | ;;; History: 24 | ;; * This keeps checkdoc happy. 25 | 26 | ;;; License 27 | ;; 28 | ;; This file is free software; you can redistribute it and/or modify 29 | ;; it under the terms of the GNU General Public License as published by 30 | ;; the Free Software Foundation; either version 3, or (at your option) 31 | ;; any later version. 32 | 33 | ;; This file is distributed in the hope that it will be useful, 34 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 35 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 36 | ;; GNU General Public License for more details. 37 | 38 | ;; You should have received a copy of the GNU General Public License 39 | ;; along with this program. If not, see . 40 | 41 | ;;; Code: 42 | ;; (eval-buffer) 43 | ;; (progn (delete-trailing-whitespace) (indent-region 0 (point-max))) 44 | ;; (byte-compile-file "ssh-config-mode.el" t) 45 | ;; (load "ssh-config-mode") 46 | 47 | ;; We use eval-and-compile so we can use them at compile 48 | ;; time and call regexp-opt during compliation. 49 | 50 | (require 'rx) 51 | 52 | (eval-and-compile 53 | (defun ssh-config-ssh-config-keywords-path () 54 | "Find the path to `ssh-config-keywords.txt'. 55 | It should be next to `ssh-config-mode.el'. 56 | When testing add `.' to load-path so you find the local copy." 57 | (let ((path (locate-library "ssh-config-keywords.txt" nil))) 58 | ;;(message "ssh-config-keywords.txt is %s" path) 59 | path)) 60 | 61 | (defun ssh-config-read-keywords (&optional file-path) 62 | "Read the list of ssh keywords, returning them as a list." 63 | ;; (message "ssh-config-read-keywords") 64 | (let ((file-path 65 | (or file-path 66 | (ssh-config-ssh-config-keywords-path)))) 67 | (with-temp-buffer 68 | (insert-file-contents file-path) 69 | (split-string (buffer-string) "\n" t)))) 70 | 71 | (defvar ssh-config-keywords 72 | (eval-when-compile 73 | (ssh-config-read-keywords))) 74 | "A list of keywords allowed in a user ssh config file." 75 | 76 | (defvar ssh-config-font-lock-keywords 77 | (eval-when-compile 78 | `(( 79 | ,(regexp-opt ssh-config-keywords 'words) 80 | (1 font-lock-keyword-face)))) 81 | "Expressions to hilight in `ssh-config-mode'.")) 82 | 83 | ;; ssh-config-font-lock-keywords 84 | 85 | ;; Setup 86 | (defvar ssh-config-mode-load-hook nil 87 | "*Hook to run when `ssh-config-mode' is loaded.") 88 | 89 | ;; 90 | (defvar ssh-config-mode-hook nil 91 | "*Hook to setup `ssh-config-mode'.") 92 | 93 | (defvar ssh-config-host-regexp "^\\s-*Host\\b" 94 | "Regexp to match the start of a host entry.") 95 | 96 | (defvar ssh-config-match-regexp "^\\s-*Match\\b" 97 | "Regexp to match the start of a match entry.") 98 | 99 | ;; 100 | (defvar ssh-config-hostname-regexp 101 | "[-_.a-zA-Z0-9]+" 102 | "Regexp to match one hostname. (rfc1123 2.1).") 103 | 104 | (defcustom ssh-config-mode-indent 2 105 | "The width of indentation to use. 106 | By default it's set to 2 as that is what man page 107 | ssh_config(5) shows it as." 108 | :type 'integer 109 | :group 'ssh-config-mode) 110 | 111 | (defun ssh-config-host-next () 112 | "Skip to the next host entry." 113 | (interactive "^") 114 | (search-forward-regexp ssh-config-host-regexp)) 115 | 116 | (defun ssh-config-host-prev () 117 | "Skip to the previous host entry." 118 | (interactive "^") 119 | (search-backward-regexp ssh-config-host-regexp)) 120 | 121 | (defun ssh-config-in-host-block-p () 122 | "Are we inside a Host block?" 123 | (save-excursion 124 | (search-backward-regexp ssh-config-host-regexp nil t))) 125 | 126 | (defun ssh-config-in-match-block-p () 127 | "Are we inside a Match block?" 128 | (save-excursion 129 | (search-backward-regexp ssh-config-match-regexp nil t))) 130 | 131 | (defun ssh-config-compute-indent () 132 | "Compute the target indent for the current line. 133 | Comments right above a 'Host' are considered to be about that Host." 134 | (save-excursion 135 | (beginning-of-line) 136 | (cond 137 | ;; Start of file and "Host" and "Match" should be at 0 138 | ((or (looking-at ssh-config-host-regexp) 139 | (looking-at ssh-config-match-regexp) 140 | (and (not (ssh-config-in-host-block-p)) 141 | (not (ssh-config-in-match-block-p)))) 142 | 0) 143 | ;; Comment line 144 | ((looking-at "\\s-*#") 145 | ;; comments right before a "Host" or "Match" should be at 0 146 | (while (looking-at "\\s-*#") 147 | (forward-line)) 148 | (if (or (looking-at ssh-config-host-regexp) 149 | (looking-at ssh-config-match-regexp)) 150 | 0 151 | ssh-config-mode-indent)) 152 | ;; default. 153 | (t 154 | ssh-config-mode-indent)))) 155 | 156 | (defun ssh-config-indent-line () 157 | "Indent lines in the SSH config file." 158 | (interactive) 159 | (let ((target (ssh-config-compute-indent))) 160 | (save-excursion 161 | (indent-line-to target)))) 162 | 163 | ;; 164 | (defvar ssh-config-mode-map 165 | (let ((map (make-sparse-keymap))) 166 | ;; Ctrl bindings 167 | (define-key map [C-down] #'ssh-config-host-next) 168 | (define-key map [C-up] #'ssh-config-host-prev) 169 | ;; 170 | (define-key map "\C-c}" #'ssh-config-host-next) 171 | (define-key map "\C-c{" #'ssh-config-host-prev) 172 | ;; 173 | (define-key map (kbd "TAB") #'indent-for-tab-command) 174 | map) 175 | "The local keymap for `ssh-config-mode'.") 176 | 177 | ;; 178 | (defvar ssh-config-mode-syntax-table nil) 179 | (unless ssh-config-mode-syntax-table 180 | (let ((table (make-syntax-table))) 181 | (modify-syntax-entry ?# "<" table) 182 | (modify-syntax-entry ?\n ">" table) 183 | (setq ssh-config-mode-syntax-table table))) 184 | 185 | (defvar ssh-config-imenu-generic-expression 186 | `(("Hosts" 187 | ,(concat ssh-config-host-regexp "\\s-+\\(" ssh-config-hostname-regexp "\\)") 1) 188 | ("Matches" 189 | ,(concat ssh-config-match-regexp "\\s-+\\(.*\\)") 1)) 190 | "Value for `imenu-generic-expression' in `ssh-config-mode'. 191 | Only show the first hostname in the menu.") 192 | 193 | (defun ssh-config-completion-at-point () 194 | "Function used for `completion-at-point-functions' in `ssh-config-mode'." 195 | (interactive) 196 | (let* ( 197 | (bds (bounds-of-thing-at-point 'symbol)) 198 | (start (car bds)) 199 | (end (cdr bds))) 200 | (list start end ssh-config-keywords . nil ))) 201 | 202 | ;;;###autoload 203 | (define-derived-mode ssh-config-mode 204 | fundamental-mode 205 | "ssh-config" 206 | "Major mode for fontifiying ssh config files. 207 | 208 | \\{ssh-config-mode-map}" 209 | (setq 210 | comment-start "#" 211 | comment-end "") 212 | (make-local-variable 'font-lock-defaults) 213 | (make-local-variable 'font-lock-keywords-case-fold-search) 214 | (setq 215 | font-lock-defaults '(ssh-config-font-lock-keywords nil t) 216 | ;; cause our keywords are all lower case. 217 | font-lock-keywords-case-fold-search t) 218 | ;; 219 | (setq-local indent-line-function 'ssh-config-indent-line 220 | imenu-generic-expression ssh-config-imenu-generic-expression) 221 | (add-hook 'completion-at-point-functions #'ssh-config-completion-at-point nil 'local)) 222 | 223 | ;;;###autoload 224 | (progn 225 | (add-to-list 'auto-mode-alist `(,(rx "/.ssh/config" (* ".d/" (+ alnum) ".conf") eos) . ssh-config-mode)) 226 | (add-to-list 'auto-mode-alist `(,(rx "/ssh" (* "d") "_config" (* ".d/" (+ alnum) ".conf") eos) . ssh-config-mode)) 227 | (add-to-list 'auto-mode-alist `(,(rx "/known_hosts" eos) . ssh-known-hosts-mode)) 228 | (add-to-list 'auto-mode-alist `(,(rx "/authorized_keys" (* "2" ".d/" alnum) eos) . ssh-authorized-keys-mode))) 229 | 230 | ;;;;; 231 | 232 | (defvar ssh-known-hosts-mode-hook nil 233 | "*Hook to setup `ssh-config-mode'.") 234 | 235 | (defvar ssh-known-hosts-mode-map 236 | (let ((map (make-sparse-keymap))) 237 | ;; Ctrl bindings 238 | map) 239 | "The local keymap for `ssh-known-hosts-mode'.") 240 | 241 | (defvar ssh-known-hosts-mode-syntax-table 242 | (let ((table (make-syntax-table))) 243 | (modify-syntax-entry ?# "<" table) 244 | (modify-syntax-entry ?\n ">" table) 245 | table) 246 | "Syntax table for `ssh-known-hosts-mode'. 247 | Just sets the comment syntax.") 248 | 249 | ;;;;; 250 | 251 | ;; host.example.com,1.1.1.1 252 | ;; |1|hash=|hash= 253 | (defvar ssh-known-hosts-regex-hashed 254 | "\\(?:|[0-9]+|[-0-9A-Za-z=|/+]+\\)" 255 | "Regex for matching hashed addresses.") 256 | 257 | (defvar ssh-known-hosts-regex-ipv4 258 | "\\(?:[0-9]+.[0-9]+.[0-9]+.[0-9]+\\)" 259 | "Regex for matching ipv4 addresses.") 260 | 261 | (defvar ssh-known-hosts-regex-ipv6 262 | "\\(?:[0-9a-f:]+\\(?:%[a-z0-9]+\\)?\\)" 263 | "Regex for matching ipv6 addresses.") 264 | 265 | (defvar ssh-known-hosts-regex-ip 266 | (concat 267 | "\\(?:" 268 | ssh-known-hosts-regex-ipv4 269 | "\\|" 270 | ssh-known-hosts-regex-ipv6 271 | "\\)") 272 | "Regex for matching ip addresses.") 273 | 274 | (defvar ssh-known-hosts-regex-ipv6 275 | "\\(?:[0-9a-f:]+\\(?:%[a-z0-9]+\\)\\)" 276 | "Regex for matching ipv6 addresses.") 277 | 278 | ;; This is more specfic than "ssh-config-hostname-regexp"; merge them? 279 | (defvar ssh-known-hosts-regex-hostname 280 | "\\(?:\\(?:[a-zA-Z0-9_][-a-zA-Z0-9_]*[.]\\)*[a-zA-Z_][-a-zA-Z0-9_]*\\)" 281 | "Regex for matching hostnames. 282 | We permit underscores.") 283 | 284 | ;; :2222 285 | (defvar ssh-known-hosts-regex-port 286 | "\\(?:[0-9]+\\)" 287 | "Regex for matching an port.") 288 | 289 | (defvar ssh-known-hosts-regex-host 290 | (concat 291 | "\\(?:" 292 | ssh-known-hosts-regex-hashed 293 | "\\|" 294 | ssh-known-hosts-regex-ip 295 | "\\|" 296 | ssh-known-hosts-regex-hostname 297 | "\\)")) 298 | 299 | (defvar ssh-known-hosts-regex-hostname-pattern 300 | (concat 301 | "\\(?:" 302 | ssh-known-hosts-regex-hostname 303 | "\\|" 304 | ssh-known-hosts-regex-ip 305 | "\\|" 306 | ;; [host-or-ip]:222 307 | "\\(?:\\[" ssh-known-hosts-regex-host "\\]:" ssh-known-hosts-regex-port "\\)" 308 | "\\)")) 309 | 310 | ;; NOTE: font-lock-studio might be of help when making changes. 311 | (defvar ssh-known-hosts-font-lock-keywords 312 | ;; We want to match lines like the following: 313 | ;; Short list in ./tests/known_hosts_short 314 | ;; Full list in ./tests/known_hosts 315 | ;; More test data in: openssh-portable/regress/unittests/hostkeys/testdata/known_hosts 316 | `( 317 | (,(concat 318 | "^" 319 | ;; @marker (optional): 320 | "\\(@[-a-z]+ +\\|\\)" 321 | 322 | ;; hostname: 323 | "\\(" 324 | 325 | ;; |1|hash=|hash= 326 | ssh-known-hosts-regex-hashed 327 | "\\|" 328 | 329 | ;; list of comma separated hostname patterns 330 | ssh-known-hosts-regex-hostname-pattern 331 | "\\(?:," 332 | ssh-known-hosts-regex-hostname-pattern 333 | "\\)*" 334 | 335 | "\\)" 336 | "[ \t]+" 337 | 338 | ;; key type: 339 | ;; ssh-rsa, ecdsa-sha2-nistp384, ... 340 | "\\(\\(?:ecdsa\\|ssh\\)[-0-9A-Za-z]*\\)" 341 | "[ \t]+" 342 | 343 | ;; public key: 344 | ;; base64data== 345 | "\\(AA[0-9A-Za-z/+]+=*\\)") 346 | (1 font-lock-warning-face) 347 | (2 font-lock-function-name-face) 348 | (3 font-lock-keyword-face) 349 | (4 font-lock-string-face))) 350 | "Expressions to hilight in `ssh-known-hosts-mode'. 351 | We want to try and be a good match, so misformatted ones stand out. 352 | So we dont just match .* for the hostname.") 353 | 354 | ;;;###autoload 355 | (defun ssh-known-hosts-mode () 356 | "Major mode for fontifiying ssh known_hosts files. 357 | \\{ssh-known-hosts-mode}" 358 | (interactive) 359 | (kill-all-local-variables) 360 | (set-syntax-table ssh-known-hosts-mode-syntax-table) 361 | (setq 362 | mode-name "ssh-known-hosts" 363 | major-mode 'ssh-known-hosts-mode 364 | comment-start "#" 365 | comment-end "") 366 | (use-local-map ssh-known-hosts-mode-map) 367 | ;; 368 | (make-local-variable 'font-lock-defaults) 369 | (setq font-lock-defaults '(ssh-known-hosts-font-lock-keywords)) 370 | ;; 371 | (run-hooks 'ssh-known-hosts-mode-hook) 372 | nil) 373 | 374 | ;;;;; 375 | 376 | ;;;###autoload (autoload 'ssh-authorized-keys-mode "ssh-config-mode" nil t) 377 | (define-generic-mode ssh-authorized-keys-mode 378 | '(?\#) 379 | nil 380 | (eval-when-compile 381 | (list 382 | (list 383 | (concat 384 | ;; ignore options 385 | ;; double quoted string will be fontified by generic mode. 386 | ;; key type 387 | "\\(\\(?:ecdsa\\|sk\\|ssh\\)-[^[:space:]]+\\)\\s-+" 388 | ;; base64 389 | "\\([0-9A-Za-z+/]+=*\\)" 390 | ;; comment in public key 391 | "\\(?: \\(.*\\)\\)?" 392 | "$") 393 | '(1 font-lock-keyword-face) 394 | '(2 font-lock-string-face) 395 | '(3 font-lock-comment-face nil t)))) 396 | ;; Not define `auto-mode-alist' obey the other mode in this elisp. 397 | nil 398 | nil) 399 | 400 | ;; done loading 401 | (run-hooks 'ssh-config-mode-load-hook) 402 | (provide 'ssh-config-mode) 403 | 404 | ;;; ssh-config-mode.el ends here 405 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------