aboutsummaryrefslogtreecommitdiff
path: root/src/connection/sudo.lisp
blob: 8ad24f3b29eaf581932d1bc2d39d980e22acd9c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
;;; Consfigurator -- Lisp declarative configuration management system

;;; Copyright (C) 2021  Sean Whitton <spwhitton@spwhitton.name>

;;; This file is free software; you can redistribute it and/or modify
;;; it under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3, or (at your option)
;;; any later version.

;;; This file is distributed in the hope that it will be useful,
;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;;; GNU General Public License for more details.

;;; You should have received a copy of the GNU General Public License
;;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

(in-package :consfigurator.connection.sudo)
(named-readtables:in-readtable :consfigurator)

;; Note that a password needed to sudo is technically not a piece of
;; prerequisite data required by a deployment, because it is not used in
;; deploying properties in the context of a connection chain which has already
;; been fully established.  Nevertheless, we can query sources of prerequisite
;; data to obtain passwords by following the conventions for having
;; prerequisite data sources provide them.

(defmethod preprocess-connection-args ((type (eql :sudo)) &key as (to "root"))
  (list :sudo
        :user to
        :password (and
                   as
                   (destructuring-bind (user host)
                       (split-string as :separator "@")
                     (get-data-protected-string
                      (strcat "--user-passwd--" host) user)))))

(defmethod establish-connection ((type (eql :sudo))
                                 remaining
                                 &key
                                   user
                                   password)
  (declare (ignore remaining))
  (informat 1 "~&Establishing sudo connection to ~A" user)
  (make-instance 'sudo-connection
                 :user user
                 ;; we'll send the password followed by ^M, then the real
                 ;; stdin.  use CODE-CHAR in this way so that we can be sure
                 ;; ASCII ^M is what will get emitted.
                 :password (and password
                                (make-passphrase
                                 (strcat (passphrase password)
                                         (string (code-char 13)))))))

(defclass sudo-connection (shell-wrap-connection)
  ((user
    :initarg :user)
   (password
    :initarg :password)))

(defmethod get-sudo-password ((connection sudo-connection))
  (let ((value (slot-value connection 'password)))
    (and value (passphrase value))))

(defmethod connection-shell-wrap ((connection sudo-connection) cmd)
  ;; wrap in sh -c so that it is more likely we are either asked for a
  ;; password for all our commands or not asked for one for any
  (format nil "sudo -HkS --prompt=\"\" --user=~A sh -c ~A"
          (slot-value connection 'user)
          (escape-sh-token (strcat "cd \"$HOME\"; " cmd))))

(defmethod connection-run ((c sudo-connection) cmd (input null))
  (call-next-method c cmd (get-sudo-password c)))

(defmethod connection-run ((c sudo-connection) cmd (input string))
  (call-next-method c cmd (strcat (get-sudo-password c) input)))

(defmethod connection-run ((connection sudo-connection) cmd (input stream))
  (call-next-method connection
                    cmd
                    (if-let ((password (get-sudo-password connection)))
                      (make-concatenated-stream
                       (if (subtypep (stream-element-type input) 'character)
                           (make-string-input-stream password)
                           (babel-streams:make-in-memory-input-stream
                            (babel:string-to-octets
                             password :encoding :UTF-8)
                            :element-type (stream-element-type input)))
                       input)
                      input)))

(defmethod connection-upload ((c sudo-connection) from to)
  (connection-run c #?"cp ${from} ${to}" nil))