├── README.md ├── ansible-vault.el └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # ansible-vault-mode 2 | 3 | Minor mode for in-place manipulations with files encrypted by [ansible-vault][ansible-vault]. 4 | 5 | ## Installation 6 | 7 | ### Recommended way 8 | 9 | Put this into `~/.emacs`: 10 | 11 | ```lisp 12 | (use-package ansible-vault :ensure t) 13 | ``` 14 | 15 | ### Manual way 16 | 17 | ``` 18 | M-x package-install RET ansible-vault RET 19 | ``` 20 | 21 | ### Development way 22 | 23 | Put this into `~/.emacs`: 24 | 25 | ```lisp 26 | (use-package git :ensure t) 27 | 28 | (defun my/setup-git-package (&rest args) 29 | (require 'git) 30 | (require 'f) 31 | (let ((repo-url (plist-get args :repo-url)) 32 | (repo-dir (plist-get args :repo-dir)) 33 | (repo-branch (plist-get args :repo-branch)) 34 | (feature (plist-get args :feature))) 35 | (unless (and repo-dir repo-url) 36 | (error "Keys :repo-dir and :repo-url are required")) 37 | (let* ((repo-branch (or repo-branch "master")) 38 | (repo-dir (f-full repo-dir))) 39 | (unless (file-directory-p repo-dir) 40 | (message "Create directory: %s" repo-dir) 41 | (make-directory repo-dir t)) 42 | (let ((git-repo repo-dir)) 43 | (unless (git-repo? repo-dir) 44 | (message "Clone repo %s to %s" repo-url repo-dir) 45 | (git-clone repo-url repo-dir)) 46 | (unless (git-on-branch? repo-branch) 47 | (message "Checkout to branch: %s" repo-branch) 48 | (git-checkout repo-branch))) 49 | (let* ((feature-filename (concat feature ".el")) 50 | (feature-file-fullpath (expand-file-name feature-filename repo-dir))) 51 | (message "Load feature from file: %s" feature-file-fullpath) 52 | (load feature-file-fullpath nil t))))) 53 | 54 | (my/setup-git-package :feature "ansible-vault" 55 | :repo-dir "~/repos/github.com/freehck/ansible-vault-mode" 56 | :repo-url "git@github.com:freehck/ansible-vault-mode.git" 57 | :repo-branch "develop") 58 | 59 | ``` 60 | 61 | ### Good old very manual way 62 | 63 | Download this repo, store somewhere on disk, and put this into `~/.emacs`: 64 | 65 | ```lisp 66 | (add-to-list 'load-path "/path/to/ansible-vault") 67 | (require 'ansible-vault) 68 | ``` 69 | 70 | 71 | 72 | ## Usage 73 | 74 | When enabled, the mode tries to find `ansible.cfg` file. First it checks `ANSIBLE_CONFIG` 75 | environment variable. If not set, it performs an upward search starting from your encrypted file 76 | location. Then it tries `~/.ansible.cfg` and eventually `/etc/ansible/ansible.cfg`. 77 | 78 | So I recommend storing `ansible.cfg` in the root of the repo with your ansible code. 79 | 80 | When the mode found `ansible.cfg` file, it takes `vault_password_file` directive from it to 81 | detirmine where to take the vault password from. Then it uses it to decrypt/encrypt the file. 82 | 83 | The mode decrypts and encrypts files automatically: decrypts when you enable the mode, encrypts back 84 | when you save the modifed buffer. 85 | 86 | After initialization it tries to activate an appropriate major-mode for by calling `normal-mode` on 87 | already decrypted buffer. 88 | 89 | In case of errors look into ```*ansible-vault-error*``` buffer. 90 | 91 | ### Vault Id configuration 92 | 93 | Ansible Vault now supports vault-id for multiple passwords. You can persistently track vault ids 94 | between sessions by configuring the `ansible-vault-vault-id-alist` value with `(vault-id 95 | . password-file)` pairs. 96 | 97 | ```lisp 98 | (setq 99 | ansible-vault-vault-id-alist 100 | '(("nonprod" . "/home/notprod/ansible/vault/nonprod-secret") 101 | ("prod" . "/home/notprod/ansible/vault/prod-secret") 102 | ("foo" . "/etc/foo.secret"))) 103 | ``` 104 | 105 | This allows properly tagged v1.2 vault files to automatically find and use their associated password 106 | files. 107 | 108 | Nota Bene:
109 | The current maintainer didn't test this functionality, so you're on your own with it. 110 | 111 | 112 | 113 | ## Release Notes 114 | 115 | ### version 0.6.1 116 | 117 | - Add compatibility fixes for Emacs 26.1 (issue #24) 118 | - Add magic-mode-alist integration (issue #26) 119 | 120 | ### version 0.6.0 121 | 122 | - Now `ansible-vault-mode` allows to change major mode, and even do it by default right after 123 | initialization, so you can work with encrypted files as if they were the ordinary ones. They will 124 | be re-encrypted when you save your changes. 125 | 126 | 127 | 128 | ### version 0.5.0 and beyond 129 | 130 | - `ansible-vault-mode` is now more aggressive in detecting valid password files. If it fails to 131 | locate a valid password file it will prompt the user for input. 132 | 133 | - The minor mode now defines some key bindings under `C-c a` 134 | - `C-c a d` Decrypts the current file and saves it 135 | - `C-c a D` Decrypts the current region 136 | - `C-c a e` Encrypts the current file and saves it 137 | - `C-c a E` Encrypts the current region 138 | - `C-c a p` Updates the password of the current buffer 139 | - `C-c a i` Updates the vault-id of the current buffer 140 | 141 | 142 | 143 | ## Contributing 144 | 145 | Bug reports and pull requests are welcome on [GitHub issues][issues]. 146 | 147 | Feature requests are welcome too, but I strongly recommend to consider filing a PR additionally. 148 | 149 | 150 | 151 | ## License 152 | 153 | This program is licensed under [GPLv3][license]. 154 | 155 | 156 | 157 | ## Authors and Contributors 158 | 159 | Zachary Elliott <contact@zell.io>
160 | Dmitrii Kashin <freehck@yandex.ru>
161 | Peter Bray [@illumino](https://github.com/illumino)
162 | 163 | 164 | 165 | [ansible-vault]: http://docs.ansible.com/ansible/playbooks_vault.html 166 | [yaml]: http://yaml.org/ 167 | [issues]: https://github.com/freehck/ansible-vault-mode 168 | [license]: https://raw.githubusercontent.com/freehck/ansible-vault-mode/refs/heads/master/LICENSE 169 | -------------------------------------------------------------------------------- /ansible-vault.el: -------------------------------------------------------------------------------- 1 | ;;; ansible-vault.el --- Minor mode for editing ansible vault files -*- lexical-binding: t; -*- 2 | 3 | ;; Copyright (C) 2016-2025 Zachary Elliott 4 | ;; Copyright (C) 2025-20.. Dmitrii Kashin 5 | ;; 6 | ;; Authors: Zachary Elliott , Dmitrii Kashin 7 | ;; Maintainer: Dmitrii Kashin 8 | ;; URL: http://github.com/freehck/ansible-vault-mode 9 | ;; Created: 2016-09-25 10 | ;; Version: 0.6.0 11 | ;; Keywords: ansible, ansible-vault, tools 12 | ;; Package-Requires: ((emacs "26.1")) 13 | 14 | ;; This file is not part of GNU Emacs. 15 | 16 | ;;; Commentary: 17 | ;; No comments 18 | 19 | ;;; License: 20 | 21 | ;; This program is free software; you can redistribute it and/or modify it 22 | ;; under the terms of the GNU General Public License as published by the Free 23 | ;; Software Foundation; either version 3 of the License, or (at your option) 24 | ;; any later version. 25 | 26 | ;; This program is distributed in the hope that it will be useful, but WITHOUT 27 | ;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 28 | ;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 29 | ;; more details. 30 | 31 | ;; You should have received a copy of the GNU General Public License along 32 | ;; with GNU Emacs; see the file COPYING. If not, write to the Free Software 33 | ;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 34 | ;; USA. 35 | 36 | ;;; Code: 37 | 38 | (require 'cl-lib) 39 | ;;;###autoload 40 | (require 'subr-x nil t) 41 | ;;;###autoload 42 | (require 'map nil t) 43 | 44 | ;; ────────────────────────────────────────────────────────────── 45 | ;; Configuration 46 | ;; ────────────────────────────────────────────────────────────── 47 | 48 | (defconst ansible-vault-version "0.6.1" 49 | "`ansible-vault' version.") 50 | 51 | (defgroup ansible-vault nil 52 | "`ansible-vault' application group." 53 | :group 'applications 54 | :link '(url-link :tag "Website for ansible-vault-mode" 55 | "https://github.com/freehck/ansible-vault-mode") 56 | :prefix "ansible-vault-") 57 | 58 | (defcustom ansible-vault-command "ansible-vault" 59 | "`ansible-vault' shell command." 60 | :type 'string 61 | :group 'ansible-vault) 62 | 63 | (defcustom ansible-vault-password-file (expand-file-name ".vault-pass" "~") 64 | "File containing `ansible-vault' password. 65 | 66 | This file is used for encryption and decryption of ansible vault 67 | files. If it is set to nil `ansible-vault-mode' will prompt 68 | you for a password." 69 | :type 'string 70 | :group 'ansible-vault) 71 | 72 | ;; Saved for now for backwards compatibility 73 | ;; I don't know if vault-id is a useful feature of ansible-vault and have never seen someone used it 74 | (defcustom ansible-vault-vault-id-alist '() 75 | "Associative list of strings containing (vault-id . password-file) pairs. 76 | 77 | This list allows for managing `ansible-vault' password files via 78 | the 1.2 vault-id syntax." 79 | :type '(alist :key-type string :value-type string) 80 | :group 'ansible-vault) 81 | 82 | (defcustom ansible-vault-minor-mode-prefix "C-c a" 83 | "Chord prefix for ansible-vault minor mode." 84 | :type 'string 85 | :group 'ansible-vault) 86 | 87 | (defvar ansible-vault--password-file-list '() 88 | "Global variable for `ansible-vault-mode'. 89 | 90 | List of generated password files that must be deleted on close.") 91 | 92 | ;; Saved because it's necessary for vault-id functionality (see #'ansible-vault--command-flags) 93 | (defvar ansible-vault--sub-command-type-alist 94 | '(("create" . :encrypt) 95 | ("decrypt" . :decrypt) 96 | ("edit" . :encrypt) 97 | ("view" . :decrypt) 98 | ("encrypt" . :encrypt) 99 | ("encrypt_string" . :encrypt) 100 | ("rekey" . :unimplemented)) 101 | "Internal variable for `ansible-vault-mode'. 102 | 103 | Mapping of ansible-vault sub-commands to internal types for flag 104 | generation.") 105 | 106 | (defvar ansible-vault--file-header-regex 107 | (rx line-start 108 | "$ANSIBLE_VAULT;1." (in (?0 . ?2)) ";AES" (optional "256") 109 | (optional ";" (one-or-more any)) 110 | line-end) 111 | "Regex for `ansible-vault' header for identifying of encrypted buffers.") 112 | 113 | ;; ────────────────────────────────────────────────────────────── 114 | ;; Internal state 115 | ;; ────────────────────────────────────────────────────────────── 116 | 117 | ;; Important: I made all the buffer-local variables to be permanent 118 | ;; as we don't wanna miss them when major mode changed 119 | 120 | ;; these are variables to store information about vault header parsing 121 | (defvar ansible-vault--header-version nil 122 | "Buffer local variable for `ansible-vault-mode'.") 123 | (make-variable-buffer-local 'ansible-vault--header-version) 124 | (put 'ansible-vault--header-version 'permanent-local t) 125 | 126 | (defvar ansible-vault--header-cipher-algorithm nil 127 | "Buffer local variable for `ansible-vault-mode'.") 128 | (make-variable-buffer-local 'ansible-vault--header-cipher-algorithm) 129 | (put 'ansible-vault--header-cipher-algorithm 'permanent-local t) 130 | 131 | (defvar ansible-vault--header-vault-id nil 132 | "Buffer local variable for `ansible-vault-mode'.") 133 | (make-variable-buffer-local 'ansible-vault--header-vault-id) 134 | (put 'ansible-vault--header-vault-id 'permanent-local t) 135 | ;; end of vault header parsing 136 | 137 | (defvar ansible-vault--point 0 138 | "Buffer local variable for `ansible-vault-mode'. 139 | 140 | Point for location continuity during encrypt and save.") 141 | (make-variable-buffer-local 'ansible-vault--point) 142 | (put 'ansible-vault--point 'permanent-local t) 143 | 144 | (defvar ansible-vault--password-file nil 145 | "Internal variable for `ansible-vault-mode'. 146 | 147 | Path of the password file for current buffer.") 148 | (make-variable-buffer-local 'ansible-vault--password-file) 149 | (put 'ansible-vault--password-file 'permanent-local t) 150 | 151 | (defvar ansible-vault--vault-id nil 152 | "Internal variable for `ansible-vault-mode'. 153 | 154 | Ansible vault-id, used for v1.2 encryption / decryption.") 155 | (make-variable-buffer-local 'ansible-vault--vault-id) 156 | (put 'ansible-vault--vault-id 'permanent-local t) 157 | 158 | (defvar ansible-vault--auto-encryption-enabled '() 159 | "Internal variable for `ansible-vault-mode'. 160 | 161 | Ansible vault auto-encryption flag. Tells the before / after 162 | save hooks to treat ansible-vault file as encrypted on disk.") 163 | (make-variable-buffer-local 'ansible-vault--auto-encryption-enabled) 164 | (put 'ansible-vault--auto-encryption-enabled 'permanent-local t) 165 | 166 | ;; ────────────────────────────────────────────────────────────── 167 | ;; Core: detection, config, password 168 | ;; ────────────────────────────────────────────────────────────── 169 | 170 | ;; vault header parsing 171 | 172 | ;;;###autoload 173 | (defun ansible-vault--fingerprint-buffer () 174 | "Parse and store the ansible-vault header values. 175 | 176 | The header \"$ANSIBLE_VAULT;1.1;AES256\" will be parsed into: 177 | version: \"1.1\" 178 | cipher-algorithm: \"AES256\" 179 | vault-id: nil 180 | " 181 | (save-excursion 182 | (goto-char (point-min)) 183 | (let* ((first-line (string-trim-right (or (thing-at-point 'line t) ""))) 184 | (header-tokens (split-string first-line ";" t)) 185 | (format-id (car header-tokens)) 186 | (version (cadr header-tokens)) 187 | (cipher-algorithm (caddr header-tokens)) 188 | (vault-id (cadddr header-tokens))) 189 | (when (string= "$ANSIBLE_VAULT" format-id) 190 | (setq-local ansible-vault--header-version version) 191 | (setq-local ansible-vault--header-cipher-algorithm cipher-algorithm) 192 | (setq-local ansible-vault--header-vault-id vault-id))))) 193 | 194 | ;;;###autoload 195 | (defun ansible-vault--is-encrypted-vault-file () 196 | "Identifies if the current buffer is an encrypted `ansible-vault' file. 197 | 198 | This function just checks if the first line of the buffer matches 199 | `ansible-vault--file-header-regex'." 200 | (save-excursion 201 | (goto-char (point-min)) 202 | (let* ((file-header (or (thing-at-point 'line t) "")) 203 | (first-match 204 | (string-match ansible-vault--file-header-regex file-header))) 205 | (and first-match (zerop first-match))))) 206 | 207 | ;; shell command generation 208 | 209 | (defun ansible-vault--sub-command-type (sub-command) 210 | "Identify type of ansible-vault subcommand for cli tool flags generation. 211 | 212 | SUB-COMMAND ansible-vault cli sub-command to type." 213 | (cdr (assoc sub-command ansible-vault--sub-command-type-alist))) 214 | 215 | (defun ansible-vault--command-flags (sub-command) 216 | "Generate the command flags for calling `ansible-vault'. 217 | 218 | SUB-COMMAND the sub-command of ansible vault as a string. Valid 219 | values can be found in `ansible-vault--sub-command-type-alist'." 220 | (let* ((type (ansible-vault--sub-command-type sub-command)) 221 | (v1.2-p (or (string= ansible-vault--header-version "1.2") 222 | ansible-vault--header-vault-id 223 | ansible-vault--vault-id))) 224 | (append 225 | '("--output=-") 226 | (if v1.2-p 227 | (let* ((vault-id-pair (assoc ansible-vault--vault-id ansible-vault-vault-id-alist)) 228 | (vault-id-str (concat (car vault-id-pair) "@" (cdr vault-id-pair)))) 229 | (list 230 | (format "--vault-id=%S" vault-id-str) 231 | (when (eq type :encrypt) (format "--encrypt-vault-id=%S" ansible-vault--vault-id)))) 232 | (list (format "--vault-password-file=%S" ansible-vault--password-file)))) 233 | )) 234 | 235 | (defun ansible-vault--shell-command (sub-command) 236 | "Generate Ansible Vault shell call for SUB-COMMAND. 237 | 238 | The command \"ansible-vault\" flags are generated via the 239 | `ansible-vault--command-flags' function. The flag values are 240 | dictated by the buffer local variables. 241 | 242 | SUB-COMMAND is the \"ansible-vault\" subcommand to use." 243 | (let* ((command-flags (ansible-vault--command-flags sub-command))) 244 | (format "%s %s %s" ansible-vault-command sub-command 245 | (mapconcat 'identity command-flags " ")))) 246 | 247 | ;; setting local variables and creating necessary files 248 | 249 | (defun ansible-vault--process-config-files () 250 | "Locate vault_password_file definitions in ansible config files. 251 | 252 | This function is patching over the fact that ansible-vault cannot 253 | handle multiple definitions for vault_password_file. This means 254 | we need to figure out if it is defined before adding a 255 | commandline flag for it." 256 | (let ((config-file 257 | (seq-find (lambda (file) (and file (file-readable-p file) file)) 258 | (list (getenv "ANSIBLE_CONFIG") 259 | (expand-file-name "ansible.cfg" 260 | (locate-dominating-file buffer-file-name "ansible.cfg")) 261 | "~/.ansible.cfg" 262 | "/etc/ansible/ansible.cfg")))) 263 | (unless (= (length config-file) 0) 264 | (with-temp-buffer 265 | (insert-file-contents config-file) 266 | (let ((content (buffer-string))) 267 | (string-match 268 | (rx line-start "vault_password_file" 269 | (zero-or-more blank) "=" (zero-or-more blank) 270 | (group (minimal-match (one-or-more not-newline))) 271 | (zero-or-more blank) (zero-or-more ";" (zero-or-more not-newline)) 272 | line-end) content) 273 | (match-string 1 content)))) 274 | )) 275 | 276 | (defun ansible-vault--create-password-file (password) 277 | "Generate a temporary file to store PASSWORD. 278 | 279 | The generated file is located in TMPDIR, and is marked read-only 280 | for owner." 281 | (let* ((temp-file (make-temp-file "ansible-vault-secret-"))) 282 | (set-file-modes temp-file #o0600) 283 | (append-to-file password nil temp-file) 284 | (set-file-modes temp-file #o0400) 285 | (setq-local ansible-vault--password-file temp-file) 286 | (push ansible-vault--password-file ansible-vault--password-file-list) 287 | temp-file)) 288 | 289 | (defun ansible-vault--request-password (password) 290 | "Prompt user a for the password for the current buffer. 291 | 292 | PASSWORD ansible-vault password to be stored." 293 | (interactive 294 | (list (read-passwd "Vault Password: "))) 295 | (ansible-vault--create-password-file password)) 296 | 297 | (defun ansible-vault--request-vault-id (vault-id &optional password-file) 298 | "Prompt user for a vault-id for the current buffer. 299 | 300 | If the vault-id doesn't have an associated password file, request 301 | a password from the user as well. 302 | 303 | VAULT-ID ansible-vault vault id. 304 | PASSWORD-FILE path to the stored secret for provided VAULT-ID." 305 | (interactive "Vault Id: ") 306 | (let* ((vault-id-pair 307 | (or (assoc vault-id ansible-vault-vault-id-alist) 308 | (let* ((password-file (or password-file 309 | (call-interactively 'ansible-vault--request-password)))) 310 | (car (push (cons vault-id password-file) ansible-vault-vault-id-alist))))) 311 | (password-file (or password-file (cdr vault-id-pair)))) 312 | (setq-local ansible-vault--vault-id vault-id) 313 | (setq-local ansible-vault--password-file password-file) 314 | vault-id-pair)) 315 | 316 | ;; side-effect: it sets ansible-vault--password-file 317 | (defun ansible-vault--guess-password-file () 318 | "Attempts to determine the correct ansible-vault password file. 319 | 320 | Ansible vault has several locations to store the configuration of 321 | its password file." 322 | (interactive) 323 | (when (not ansible-vault--password-file) 324 | (let* ((env-val (or (getenv "ANSIBLE_VAULT_PASSWORD_FILE") "")) 325 | (vault-id-pair (assoc ansible-vault--header-vault-id ansible-vault-vault-id-alist)) 326 | (ansible-config-path (ansible-vault--process-config-files))) 327 | (cond 328 | (vault-id-pair 329 | (setq-local ansible-vault--vault-id (car vault-id-pair)) 330 | (setq-local ansible-vault--password-file (cdr vault-id-pair))) 331 | (ansible-vault--header-vault-id 332 | (ansible-vault--request-vault-id ansible-vault--header-vault-id)) 333 | (t (let* ((password-file 334 | (or (and (not (string-empty-p env-val)) env-val) 335 | ansible-config-path 336 | ansible-vault-password-file))) 337 | (setq-local 338 | ansible-vault--password-file password-file)))) 339 | )) 340 | (when (not (and ansible-vault--password-file (file-readable-p ansible-vault--password-file))) 341 | (let* ((vault-id (or ansible-vault--header-vault-id ansible-vault--vault-id))) 342 | (cond (vault-id (ansible-vault--request-vault-id vault-id)) 343 | (t (call-interactively 'ansible-vault--request-password))) 344 | )) 345 | ansible-vault--password-file) 346 | 347 | ;; unsetting variables and deleting unnecessary files 348 | 349 | (defun ansible-vault--flush-password-file () 350 | "Delete password file and associated buffer local variables." 351 | (when ansible-vault--password-file 352 | (when (member ansible-vault--password-file ansible-vault--password-file-list) 353 | (setq ansible-vault--password-file-list 354 | (remove ansible-vault--password-file ansible-vault--password-file-list)) 355 | (delete-file ansible-vault--password-file)) 356 | (setq-local ansible-vault--password-file nil))) 357 | 358 | (defun ansible-vault--flush-vault-id () 359 | "Delete vault-id pair and associated buffer local variables." 360 | (when ansible-vault--vault-id 361 | (when (map-contains-key ansible-vault-vault-id-alist ansible-vault--vault-id) 362 | (setq ansible-vault-vault-id-alist 363 | (map-filter (lambda (key _) 364 | (not (string= key ansible-vault--vault-id))) 365 | ansible-vault-vault-id-alist))) 366 | (setq-local ansible-vault--vault-id nil) 367 | (ansible-vault--flush-password-file))) 368 | 369 | (defun ansible-vault--cleanup-password-error () 370 | "Flush both vault and password values." 371 | (when ansible-vault--vault-id 372 | (ansible-vault--flush-vault-id)) 373 | (when ansible-vault--password-file 374 | (ansible-vault--flush-password-file))) 375 | 376 | (defun ansible-vault--clear-local-variables () 377 | "Unset all buffer local variables." 378 | (dolist (var '(ansible-vault--header-version 379 | ansible-vault--header-cipher-algorithm 380 | ansible-vault--header-vault-id 381 | ansible-vault--point 382 | ansible-vault--password-file 383 | ansible-vault--vault-id 384 | ansible-vault--auto-encryption-enabled)) 385 | (makunbound var))) 386 | 387 | ;; error handling 388 | 389 | (defun ansible-vault--error-buffer () 390 | "Generate or return `ansible-vaul't error report buffer." 391 | (or (get-buffer "*ansible-vault-error*") 392 | (let ((buffer (get-buffer-create "*ansible-vault-error*"))) 393 | (save-current-buffer 394 | (set-buffer buffer) 395 | (setq-local buffer-read-only t)) 396 | buffer))) 397 | 398 | ;; run ansible-vault cli tool 399 | 400 | (defun ansible-vault--execute-on-region (command &optional start end buffer error-buffer) 401 | "In place execution of a given COMMAND using `ansible-vault'. 402 | 403 | START defaults to `point-min'. 404 | END defaults to `point-max'. 405 | BUFFER defaults to current buffer. 406 | ERROR-BUFFER defaults to `ansible-vault--error-buffer'." 407 | (let* (;; Silence messages 408 | (inhibit-message t) 409 | (message-log-max nil) 410 | 411 | ;; Set default arguments 412 | (start (or start (point-min))) 413 | (end (or end (point-max))) 414 | (error-buffer (or error-buffer (ansible-vault--error-buffer))) 415 | 416 | ;; Local variables 417 | (ansible-vault-stdout (get-buffer-create "*ansible-vault-stdout*")) 418 | (ansible-vault-stderr (get-buffer-create "*ansible-vault-stderr*"))) 419 | (ansible-vault--guess-password-file) 420 | (unwind-protect 421 | (progn 422 | (let ((shell-command (ansible-vault--shell-command command))) 423 | (let ((env-ansible-vault-password-file (getenv "ANSIBLE_VAULT_PASSWORD_FILE"))) 424 | (unwind-protect 425 | (progn 426 | (setenv "ANSIBLE_VAULT_PASSWORD_FILE" nil) 427 | (shell-command-on-region start end shell-command 428 | ansible-vault-stdout nil 429 | ansible-vault-stderr nil)) 430 | (setenv "ANSIBLE_VAULT_PASSWORD_FILE" env-ansible-vault-password-file))) 431 | (if (zerop (buffer-size ansible-vault-stderr)) 432 | (progn 433 | (delete-region start end) 434 | (insert-buffer-substring ansible-vault-stdout)) 435 | (let ((inhibit-read-only t)) 436 | (switch-to-buffer error-buffer) 437 | (goto-char (point-max)) 438 | (insert "$ " shell-command "\n") 439 | (insert-buffer-substring ansible-vault-stderr) 440 | (insert "\n") 441 | (ansible-vault--cleanup-password-error))) 442 | )) 443 | (kill-buffer ansible-vault-stdout) 444 | (kill-buffer ansible-vault-stderr)) 445 | )) 446 | 447 | ;; interactive actions 448 | (defun ansible-vault-decrypt-current-buffer () 449 | "In place decryption of `current-buffer' using `ansible-vault'." 450 | (interactive) 451 | (ansible-vault--execute-on-region "decrypt")) 452 | 453 | (defun ansible-vault-decrypt-current-file () 454 | "Decrypts the current buffer and writes the file." 455 | (interactive) 456 | (setq-local ansible-vault--auto-encryption-enabled nil) 457 | (ansible-vault-decrypt-current-buffer) 458 | (save-buffer 0)) 459 | 460 | (defun ansible-vault-encrypt-current-buffer () 461 | "In place encryption of `current-buffer' using `ansible-vault'." 462 | (interactive) 463 | (ansible-vault--execute-on-region "encrypt")) 464 | 465 | (defun ansible-vault-encrypt-current-file () 466 | "Encrypts the current buffer and writes the file." 467 | (interactive) 468 | (setq-local ansible-vault--auto-encryption-enabled t) 469 | (set-buffer-modified-p t) 470 | (save-buffer 0) 471 | (ansible-vault--fingerprint-buffer)) 472 | 473 | (defun ansible-vault-decrypt-region (start end) 474 | "In place decryption of region from START to END using `ansible-vault'." 475 | (interactive "r") 476 | (let ((inhibit-read-only t)) 477 | ;; Restrict the following operations to the selected region. 478 | (narrow-to-region start end) 479 | (goto-char (point-min)) 480 | ;; Delete header and save non-vault values 481 | (let* ((first-line (thing-at-point 'line t)) 482 | (match-data (string-match (rx line-start (group (zero-or-more any)) "!vault |" line-end) first-line)) 483 | (header (match-string 1 first-line))) 484 | ;; remove header if it exists 485 | (when (and match-data (zerop match-data)) 486 | (kill-whole-line)) 487 | ;; realign encrypted data 488 | (goto-char (point-min)) 489 | (let* ((line-count 0)) 490 | (while (zerop line-count) 491 | (delete-horizontal-space) 492 | (setq 493 | line-count (forward-line)))) 494 | ;; fingerprint new buffer 495 | (ansible-vault--fingerprint-buffer) 496 | ;; decrypt region 497 | (ansible-vault-decrypt-current-buffer) 498 | ;; replace header 499 | (when header 500 | (goto-char (point-min)) 501 | (insert header))) 502 | ;; show the whole buffer again 503 | (widen))) 504 | 505 | (defun ansible-vault-encrypt-region (start end) 506 | "In place encryption of region from START to END using `ansible-vault'." 507 | (interactive "r") 508 | (ansible-vault--execute-on-region "encrypt_string" start end)) 509 | 510 | ;; key mapping 511 | 512 | (defun ansible-vault--chord (chord) 513 | "Key sequence generator for ansible-vault minor mode. 514 | 515 | CHORD is the trailing key sequence to append ot the mode prefix." 516 | (kbd (concat ansible-vault-minor-mode-prefix " " chord))) 517 | 518 | (defvar ansible-vault-mode-map 519 | (let ((map (make-sparse-keymap))) 520 | (define-key map (ansible-vault--chord "d") 'ansible-vault-decrypt-current-file) 521 | (define-key map (ansible-vault--chord "D") 'ansible-vault-decrypt-region) 522 | (define-key map (ansible-vault--chord "e") 'ansible-vault-encrypt-current-file) 523 | (define-key map (ansible-vault--chord "E") 'ansible-vault-encrypt-region) 524 | (define-key map (ansible-vault--chord "p") 'ansible-vault--request-password) 525 | (define-key map (ansible-vault--chord "i") 'ansible-vault--request-vault-id) 526 | map) 527 | "Keymap for `ansible-vault' minor mode.") 528 | 529 | ;; hooks 530 | 531 | (defun ansible-vault--before-save-hook () 532 | "`before-save-hook' for files managed by `ansible-vault-mode'. 533 | 534 | Saves the current position and encrypts the file before writing 535 | to disk." 536 | (when (and ansible-vault--auto-encryption-enabled 537 | (not (ansible-vault--is-encrypted-vault-file))) 538 | (setq-local ansible-vault--point (point)) 539 | (ansible-vault-encrypt-current-buffer))) 540 | 541 | (defun ansible-vault--after-save-hook () 542 | "`after-save-hook' for files managed by `ansible-vault-mode'. 543 | 544 | Decrypts the file, and returns the point to the position saved by 545 | the `before-save-hook'." 546 | (when (and ansible-vault--auto-encryption-enabled 547 | (ansible-vault--is-encrypted-vault-file)) 548 | (ansible-vault-decrypt-current-buffer) 549 | (set-buffer-modified-p nil) 550 | (goto-char ansible-vault--point) 551 | (setq-local ansible-vault--point 0))) 552 | 553 | (defun ansible-vault--kill-buffer-hook () 554 | "`kill-buffer-hook' for buffers managed by `ansible-vault-mode'. 555 | 556 | Flushes saved password state." 557 | (when ansible-vault--vault-id 558 | (ansible-vault--flush-vault-id)) 559 | (when ansible-vault--password-file 560 | (ansible-vault--flush-password-file))) 561 | 562 | ;;;###autoload 563 | (defun ansible-vault--kill-emacs-hook () 564 | "`kill-emacs-hook' for Emacs when `ansible-vault-mode' is loaded. 565 | 566 | Ensures deletion of ansible-vault generated password files." 567 | (dolist (file ansible-vault--password-file-list) 568 | (when (file-readable-p file) 569 | (delete-file file)) 570 | )) 571 | 572 | ;; ────────────────────────────────────────────────────────────── 573 | ;; Mode 574 | ;; ────────────────────────────────────────────────────────────── 575 | 576 | ;;;###autoload 577 | (define-minor-mode ansible-vault-mode 578 | "Minor mode for manipulating ansible-vault files" 579 | :lighter " ansible-vault" 580 | :keymap ansible-vault-mode-map 581 | :group 'ansible-vault 582 | 583 | (if ansible-vault-mode 584 | ;; Enable the mode 585 | (progn 586 | ;; Disable backups 587 | (setq-local 588 | backup-inhibited t) 589 | 590 | ;; Disable auto-save 591 | (when auto-save-default 592 | (auto-save-mode -1)) 593 | 594 | ;; Decrypt the current buffer first if it needs to be 595 | (when (ansible-vault--is-encrypted-vault-file) 596 | (setq-local 597 | ansible-vault--auto-encryption-enabled t) 598 | (ansible-vault--fingerprint-buffer) 599 | (ansible-vault-decrypt-current-buffer) 600 | (set-buffer-modified-p nil)) 601 | 602 | ;; Add mode hooks 603 | (add-hook 'before-save-hook 'ansible-vault--before-save-hook t t) 604 | (add-hook 'after-save-hook 'ansible-vault--after-save-hook t t) 605 | (add-hook 'kill-buffer-hook 'ansible-vault--kill-buffer-hook t t) 606 | 607 | ;; make hooks resistant to kill-all-local-variables 608 | (put 'before-save-hook 'permanent-local t) 609 | (put 'after-save-hook 'permanent-local t) 610 | (put 'kill-buffer-hook 'permanent-local t) 611 | 612 | ;; change major mode 613 | (normal-mode) 614 | ) 615 | 616 | ;; Disable the mode 617 | (remove-hook 'after-save-hook 'ansible-vault--after-save-hook t) 618 | (remove-hook 'before-save-hook 'ansible-vault--before-save-hook t) 619 | (remove-hook 'kill-buffer-hook 'ansible-vault--kill-buffer-hook t) 620 | 621 | ;; Only re-encrypt the buffer if buffer is changed; otherwise revert 622 | ;; to on-disk contents. 623 | (if (and (buffer-modified-p) (not (ansible-vault--is-encrypted-vault-file))) 624 | (ansible-vault-encrypt-current-buffer) 625 | (revert-buffer nil t nil)) 626 | 627 | ;; Clean up password state 628 | (ansible-vault--flush-password-file) 629 | (ansible-vault--flush-vault-id) 630 | 631 | (if auto-save-default (auto-save-mode 1)) 632 | 633 | (setq-local 634 | backup-inhibited nil) 635 | 636 | (ansible-vault--clear-local-variables))) 637 | 638 | ;; ────────────────────────────────────────────────────────────── 639 | ;; Integrations 640 | ;; ────────────────────────────────────────────────────────────── 641 | 642 | (add-to-list 'magic-mode-alist 643 | (cons #'ansible-vault--is-encrypted-vault-file #'ansible-vault-mode)) 644 | 645 | ;; ────────────────────────────────────────────────────────────── 646 | ;; Obsolete aliases (explicit!) 647 | ;; ────────────────────────────────────────────────────────────── 648 | 649 | (define-obsolete-variable-alias 650 | 'ansible-vault-pass-file 'ansible-vault-password-file "0.4.0" 651 | "Migrated to unify naming conventions.") 652 | 653 | (define-obsolete-variable-alias 654 | 'ansible-vault--is-vault-file 'ansible-vault--is-encrypted-vault-file "0.4.2" 655 | "Renamed for semantic correctness.") 656 | 657 | (define-obsolete-variable-alias 658 | 'ansible-vault--flush-password 'ansible-vault--flush-password-file "0.4.2" 659 | "Renamed for semantic correctness.") 660 | 661 | ;; ────────────────────────────────────────────────────────────── 662 | ;; Footer 663 | ;; ────────────────────────────────────────────────────────────── 664 | 665 | (provide 'ansible-vault) 666 | 667 | ;;; ansible-vault.el ends here 668 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | . --------------------------------------------------------------------------------