aboutsummaryrefslogtreecommitdiff
path: root/flakes/rsync_backup/flake.nix
blob: d81d1762318f26b579fc1a5485d6e9ff2afe7c16 (plain) (blame)
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
{
  description = "Rsync backups";

  outputs = { self }: {
    nixosModule = { lib, pkgs, config, ... }: {
      options.services.rsyncBackup = {
        mountpoint = lib.mkOption {
          type = lib.types.path;
          description = "Path to the base folder for backups";
        };
        profiles = lib.mkOption {
          type = lib.types.attrsOf (lib.types.submodule {
            options = {
              keep = lib.mkOption {
                type = lib.types.int;
                default = 7;
                description = ''
                  Number of backups to keep
                  '';
              };
              check_command = lib.mkOption {
                type = lib.types.str;
                default = "backup";
                description = ''
                  command to check if backup needs to be done
                '';
              };
              login = lib.mkOption {
                type = lib.types.str;
                description = ''
                  login to connect to
                  '';
              };
              host = lib.mkOption {
                type = lib.types.str;
                description = ''
                  host to connect to
                  '';
              };
              port = lib.mkOption {
                type = lib.types.str;
                default = "22";
                description = ''
                  port to connect to
                  '';
              };
              host_key = lib.mkOption {
                type = lib.types.str;
                description = ''
                  Host key to use as known host
                  '';
              };
              host_key_type = lib.mkOption {
                type = lib.types.str;
                description = ''
                  Host key type
                  '';
              };
              parts = lib.mkOption {
                type = lib.types.attrsOf (lib.types.submodule {
                  options = {
                    remote_folder = lib.mkOption {
                      type = lib.types.path;
                      description = ''
                        Path to backup
                        '';
                    };
                    exclude_from = lib.mkOption {
                      type = lib.types.listOf lib.types.path;
                      default = [];
                      description = ''
                        Paths to exclude from the backup
                        '';
                    };
                    files_from = lib.mkOption {
                      type = lib.types.listOf lib.types.path;
                      default = [];
                      description = ''
                        Paths to take for the backup
                        (if empty: whole folder minus exclude_from)
                        '';
                    };
                    args = lib.mkOption {
                      type = lib.types.nullOr lib.types.str;
                      default = null;
                      description = ''
                        additional arguments for rsync
                        '';
                    };
                  };
                });
                description = ''
                  folders to backup in the host
                  '';
              };
            };
          });
          default = {};
          description = ''
            Profiles to backup
            '';
        };
        ssh_key_public = lib.mkOption {
          type = lib.types.str;
          description = "Public key for the backup";
        };
        ssh_key_private = lib.mkOption {
          type = lib.types.str;
          description = "Private key for the backup";
        };
      };

      config =
        let
          cfg = config.services.rsyncBackup;
        in
          lib.mkIf (builtins.length (builtins.attrNames cfg.profiles) > 0) {
            users.users.backup = {
              isSystemUser = true;
              uid = config.ids.uids.backup;
              group = "backup";
              extraGroups = [ "keys" ];
            };

            users.groups.backup = {
              gid = config.ids.gids.backup;
            };

            services.cron.systemCronJobs = let
              ssh_key = cfg.ssh_key_private;
              backup_head = ''
                #!${pkgs.stdenv.shell}
                EXCL_FROM=`mktemp`
                FILES_FROM=`mktemp`
                TMP_STDERR=`mktemp`

                on_exit() {
                  if [ -s "$TMP_STDERR" ]; then
                    cat "$TMP_STDERR"
                  fi
                  rm -f $TMP_STDERR $EXCL_FROM $FILES_FROM
                }

                trap "on_exit" EXIT

                exec 2> "$TMP_STDERR"
                exec < /dev/null

                set -e
                '';
              backup_profile_head = name: profile: ''
                  ##### ${name} #####
                  PORT="${profile.port}"
                  DEST="${profile.login}@${profile.host}"
                  BASE="${cfg.mountpoint}/${name}"
                  OLD_BAK_BASE=$BASE/older/j
                  BAK_BASE=''${OLD_BAK_BASE}0
                  RSYNC_OUTPUT=$BASE/rsync_output
                  NBR=${builtins.toString profile.keep}

                  if ! ssh \
                      -o PreferredAuthentications=publickey \
                      -o StrictHostKeyChecking=yes \
                      -o ClearAllForwardings=yes \
                      -o UserKnownHostsFile=/dev/null \
                      -o CheckHostIP=no \
                      -p $PORT \
                      -i ${ssh_key} \
                      $DEST ${profile.check_command}; then
                    echo "Fichier de verrouillage backup sur $DEST ou impossible de se connecter" >&2
                    skip=$DEST
                  fi

                  rm -rf ''${OLD_BAK_BASE}''${NBR}
                  for j in `seq -w $(($NBR-1)) -1 0`; do
                    [ ! -d ''${OLD_BAK_BASE}$j ] && continue
                    mv ''${OLD_BAK_BASE}$j ''${OLD_BAK_BASE}$(($j+1))
                  done
                  mkdir $BAK_BASE
                  mv $RSYNC_OUTPUT $BAK_BASE
                  mkdir $RSYNC_OUTPUT

                  if [ "$skip" != "$DEST" ]; then
                '';
              backup_profile_tail = name: profile: ''
                  ssh -o UserKnownHostsFile=/dev/null -o CheckHostIP=no -i ${ssh_key} -p $PORT $DEST sh -c "date > .cache/last_backup" || true
                fi # [ "$skip" != "$DEST" ]
                ##### End ${name} #####
              '';

              backup_part = profile_name: part_name: part: ''
                ### ${profile_name} ${part_name} ###
                LOCAL="${part_name}"
                REMOTE="${part.remote_folder}"

                if [ ! -d "$BASE/$LOCAL" ]; then
                  mkdir $BASE/$LOCAL
                fi
                cd $BASE/$LOCAL
                cat > $EXCL_FROM <<EOF
                ${builtins.concatStringsSep "\n" part.exclude_from}
                EOF
                cat > $FILES_FROM <<EOF
                ${builtins.concatStringsSep "\n" part.files_from}
                EOF

                OUT=$RSYNC_OUTPUT/$LOCAL
                ${pkgs.rsync}/bin/rsync --new-compress -XAavbr --fake-super -e "ssh -o UserKnownHostsFile=/dev/null -o CheckHostIP=no -i ${ssh_key} -p $PORT" --numeric-ids --delete \
                  --backup-dir=$BAK_BASE/$LOCAL \${
                  lib.optionalString (part.args != null) "\n  ${part.args} \\"}${
                  lib.optionalString (builtins.length part.exclude_from > 0) "\n  --exclude-from=$EXCL_FROM \\"}${
                  lib.optionalString (builtins.length part.files_from > 0) "\n  --files-from=$FILES_FROM \\"}
                  $DEST:$REMOTE . > $OUT || true
                ### End ${profile_name} ${part_name} ###
              '';
              backup_profile = name: profile: builtins.concatStringsSep "\n" (
                [(backup_profile_head name profile)]
                ++ lib.mapAttrsToList (backup_part name) profile.parts
                ++ [(backup_profile_tail name profile)]);

              backup = pkgs.writeScript "backup.sh" (builtins.concatStringsSep "\n" ([
                backup_head
              ] ++ lib.mapAttrsToList backup_profile cfg.profiles));
            in [
              ''
                25 3,15 * * * backup ${backup}
                ''
            ];

            programs.ssh.knownHosts = lib.attrsets.mapAttrs' (name: profile: lib.attrsets.nameValuePair name {
              extraHostNames = [ profile.host ];
              publicKey = "${profile.host_key_type} ${profile.host_key}";
            }) cfg.profiles;

            system.activationScripts.rsyncBackup = {
              deps = [ "users" ];
              text = builtins.concatStringsSep "\n" (map (v: ''
                install -m 0700 -o backup -g backup -d ${cfg.mountpoint}/${v} ${cfg.mountpoint}/${v}/older ${cfg.mountpoint}/${v}/rsync_output
                '') (builtins.attrNames cfg.profiles)
                );
            };
          };
      };
  };
}