summaryrefslogtreecommitdiff
path: root/tuf/release.py
blob: 0e1c989c2b83ae4ceff1f01631489a7d8920046f (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
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
#!/usr/bin/env python
# release.py
# Copyright (C) 2014 LEAP
#
# This program 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 of the License, or
# (at your option) any later version.
#
# This program 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/>.

"""
Tool to generate TUF related files after a release

The 'repo' folder should contain two folders:
  - 'metadata.staged' with all the jsons from the previows release
  - 'targets' where the release targets are
"""

import datetime
import os.path
import sys

from tuf.repository_tool import load_repository
from tuf.repository_tool import import_rsa_privatekey_from_file

"""
Days until the expiration of targets.json and snapshot.json. After this ammount
of days the TUF client won't accept this files.
"""
EXPIRATION_DAYS = 90


def usage():
    print "Usage:  %s repo key" % (sys.argv[0],)


def main():
    if len(sys.argv) < 3:
        usage()
        return

    repo_path = sys.argv[1]
    key_path = sys.argv[2]
    targets = Targets(repo_path, key_path)
    targets.build()

    print "%s/metadata.staged/(targets|snapshot).json[.gz] are ready" % \
          (repo_path,)


class Targets(object):
    """
    Targets builder class
    """

    def __init__(self, repo_path, key_path):
        """
        Constructor

        :param repo_path: path where the repo lives
        :type repo_path: str
        :param key_path: path where the private targets key lives
        :type key_path: str
        """
        self._repo_path = repo_path
        self._key = import_rsa_privatekey_from_file(key_path)

    def build(self):
        """
        Generate snapshot.json[.gz] and targets.json[.gz]
        """
        self._repo = load_repository(self._repo_path)
        self._load_targets()

        self._repo.targets.load_signing_key(self._key)
        self._repo.snapshot.load_signing_key(self._key)
        self._repo.targets.compressions = ["gz"]
        self._repo.snapshot.compressions = ["gz"]
        self._repo.snapshot.expiration = (
            datetime.datetime.now() +
            datetime.timedelta(days=EXPIRATION_DAYS))
        self._repo.targets.expiration = (
            datetime.datetime.now() +
            datetime.timedelta(days=EXPIRATION_DAYS))
        self._repo.write_partial()

    def _load_targets(self):
        """
        Load a list of targets
        """
        targets_path = os.path.join(self._repo_path, 'targets')
        target_list = self._repo.get_filepaths_in_directory(
            targets_path,
            recursive_walk=True,
            followlinks=True)

        self._remove_obsolete_targets(target_list)

        for target in target_list:
            octal_file_permissions = oct(os.stat(target).st_mode)[3:]
            custom_file_permissions = {
                'file_permissions': octal_file_permissions
            }
            self._repo.targets.add_target(target, custom_file_permissions)

    def _remove_obsolete_targets(self, target_list):
        """
        Remove obsolete targets from TUF targets

        :param target_list: list of targets on full path comming from TUF
                            get_filepaths_in_directory
        :type target_list: list(str)
        """
        targets_path = os.path.join(self._repo_path, 'targets')
        relative_path_list = map(lambda t: t.split("/targets")[1], target_list)
        removed_targets = (set(self._repo.targets.target_files.keys())
                           - set(relative_path_list))

        for target in removed_targets:
            target_rel_path = target
            if target[0] == '/':
                target_rel_path = target[1:]
            target_path = os.path.join(targets_path, target_rel_path)
            self._repo.targets.remove_target(target_path)


if __name__ == "__main__":
    main()