~usn-tool/usn-tool/trunk

« back to all changes in this revision

Viewing changes to README

  • Committer: Steve Beattie
  • Date: 2019-02-19 07:48:48 UTC
  • Revision ID: sbeattie@ubuntu.com-20190219074848-2hmbpko59tlrzeav
The usn-tool repository has been converted to git.

To get the converted repository, please use:
  git clone https://git.launchpad.net/usn-tool

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Dependencies
2
 
------------
3
 
 
4
 
The USN tool depends on python-yaml, and on a version of the Genshi
5
 
templating library greater than 0.5.
6
 
 
7
 
 
8
 
USN Database
9
 
------------
10
 
 
11
 
The USN database is stored in ~/.usn.db in a binary format.
12
 
 
13
 
 
14
 
Importing and exporting
15
 
-----------------------
16
 
 
17
 
The USN tool allows importing and exporting data in the YAML format.
18
 
 
19
 
To export one USN, use a command like:
20
 
 
21
 
    usn.py 497-1 --export > usn-497-1.txt
22
 
 
23
 
 
24
 
To export all of the existing USNs, use the following command:
25
 
 
26
 
    usn.py --export > usn-all.txt
27
 
 
28
 
 
29
 
The resulting files may be edited and reinserted back in the database
30
 
by importing them:
31
 
 
32
 
   cat usn-497-1.txt | usn.py --import
33
 
 
34
 
 
35
 
Notice that any USNs present in the imported file will *replace*
36
 
existing data for the given USNs, rather than changing them.
37
 
 
38
 
 
39
 
Configuration
40
 
-------------
41
 
 
42
 
The configuration is stored in ~/.usn.conf, and so far the only option
43
 
supported is a [restrictions] section that allows limiting the values
44
 
accepted for certain command line options.
45
 
 
46
 
For instance, to limit which values are accepted in --release, use
47
 
something like follows:
48
 
 
49
 
  [restrictions]
50
 
  release = dapper edgy feisty
51
 
 
52
 
 
53
 
This will ensure that incorrect data isn't entered in the command line,
54
 
what would generate invalid output.
55
 
 
56
 
 
57
 
Updating the database
58
 
---------------------
59
 
 
60
 
Each time the USN tool command is run to update an USN entry, values are
61
 
changed or appended to existing values, what means that several commands
62
 
run in succession will complement the same USN rather than replacing it.
63
 
 
64
 
To update the database, just provide the USN id as an argument, and any
65
 
wanted changes following it.
66
 
 
67
 
The following commands recreate data in the database to reconstruct
68
 
USN-497-1.
69
 
 
70
 
    usn.py 497-1 --summary "xfce4-terminal vulnerability"
71
 
    usn.py 497-1 --timestamp 1187103600 --cve CVE-2007-3770
72
 
 
73
 
    usn.py 497-1 --release dapper --package xfce4-terminal \
74
 
                  --binary-version 0.2.5+r21674-0ubuntu2.1
75
 
    usn.py 497-1 --release edgy --package xfce4-terminal \
76
 
                 --binary-version 0.2.5.4-0ubuntu2.1
77
 
    usn.py 497-1 --release feisty --package xfce4-terminal \
78
 
                 --binary-version 0.2.6-0ubuntu3.1
79
 
 
80
 
    usn.py 497-1 --description - <<END
81
 
Lasse Kärkkäinen discovered that the Xfce Terminal did not correctly
82
 
escape shell meta-characters during "Open Link" actions.  If a remote
83
 
attacker tricked a user into opening a specially crafted URI, they could
84
 
execute arbitrary commands with the user's privileges.
85
 
END
86
 
 
87
 
    usn.py 497-1 --release dapper --arch src \
88
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674-0ubuntu2.1.diff.gz \
89
 
        --url-size 7892 --url-md5 902a748e0c0fe963aed9f62d7492247c
90
 
 
91
 
    usn.py 497-1 --release dapper --arch src \
92
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674-0ubuntu2.1.dsc \
93
 
        --url-size 982 --url-md5 7ab2af378e2db311101541887b3d899f
94
 
 
95
 
    usn.py 497-1 --release dapper --arch src \
96
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674-0ubuntu2.1.dsc \
97
 
        --url-size 982 --url-md5 7ab2af378e2db311101541887b3d899f
98
 
 
99
 
    usn.py 497-1 --release dapper --arch src \
100
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674.orig.tar.gz \
101
 
        --url-size 1719502 --url-md5 202f3d5364127ee2cd3434e7fecad5d2
102
 
 
103
 
    usn.py 497-1 --release dapper --arch amd64 \
104
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674-0ubuntu2.1_amd64.deb \
105
 
        --url-size 1005574 --url-md5 5b196f5dc586000452233f215248423b
106
 
    
107
 
    usn.py 497-1 --release dapper --arch i386 \
108
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674-0ubuntu2.1_i386.deb \
109
 
        --url-size 998716 --url-md5 7476e02c550b2876da957249e126ba91
110
 
 
111
 
    usn.py 497-1 --release dapper --arch powerpc \
112
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674-0ubuntu2.1_powerpc.deb \
113
 
        --url-size 1002380 --url-md5 eec3f73feb99b58aaef302ffa0cf24b8
114
 
 
115
 
    usn.py 497-1 --release dapper --arch sparc \
116
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5+r21674-0ubuntu2.1_sparc.deb \
117
 
        --url-size 1000628 --url-md5 822e33229ad34eb7703051a8ea3eab88
118
 
 
119
 
 
120
 
    usn.py 497-1 --release edgy --arch src \
121
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5.4-0ubuntu2.1.diff.gz \
122
 
        --url-size 7764 --url-md5 6759a5320fc94d1c95d2fd68dbbf974d
123
 
 
124
 
    usn.py 497-1 --release edgy --arch src \
125
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5.4-0ubuntu2.1.dsc \
126
 
        --url-size 967 --url-md5 5556541b5e806d77a068018609d97674
127
 
 
128
 
    usn.py 497-1 --release edgy --arch src \
129
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5.4.orig.tar.gz \
130
 
        --url-size 1914192 --url-md5 858ff414d46c2bdd695da3874ef01090
131
 
 
132
 
    usn.py 497-1 --release edgy --arch amd64 \
133
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5.4-0ubuntu2.1_amd64.deb \
134
 
        --url-size 1010080 --url-md5 607dc6c46565dac2cfa378134e5d91e2
135
 
 
136
 
    usn.py 497-1 --release edgy --arch i386 \
137
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5.4-0ubuntu2.1_i386.deb \
138
 
        --url-size 1004880 --url-md5 343ed30f5a69e7caeb081269c7300b31
139
 
 
140
 
    usn.py 497-1 --release edgy --arch powerpc \
141
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5.4-0ubuntu2.1_powerpc.deb \
142
 
        --url-size 1006248 --url-md5 2c3e3ff2ceb6711f055b4e1af3c28607
143
 
 
144
 
    usn.py 497-1 --release edgy --arch sparc \
145
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.5.4-0ubuntu2.1_sparc.deb \
146
 
        --url-size 1004086 --url-md5 b7744640ce68f8f8d8763dee3414ffb8
147
 
 
148
 
 
149
 
    usn.py 497-1 --release feisty --arch src \
150
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.6-0ubuntu3.1.diff.gz \
151
 
        --url-size 8617 --url-md5 2ed6e7705918937831599b2c3d366777
152
 
 
153
 
    usn.py 497-1 --release feisty --arch src \
154
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.6-0ubuntu3.1.dsc \
155
 
        --url-size 1043 --url-md5 435a5294f568d44abbd907bec892e50e
156
 
 
157
 
    usn.py 497-1 --release feisty --arch src \
158
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.6.orig.tar.gz \
159
 
        --url-size 1989139 --url-md5 c93cc68cc7656dfcb57118a999b79242
160
 
 
161
 
    usn.py 497-1 --release feisty --arch amd64 \
162
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.6-0ubuntu3.1_amd64.deb \
163
 
        --url-size 1014248 --url-md5 8af1dd3b37a96344c3a892de94745867
164
 
 
165
 
    usn.py 497-1 --release feisty --arch i386 \
166
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.6-0ubuntu3.1_i386.deb \
167
 
        --url-size 1008944 --url-md5 a3e14fefeecbc2b3128652b809c5a27a
168
 
 
169
 
    usn.py 497-1 --release feisty --arch powerpc \
170
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.6-0ubuntu3.1_powerpc.deb \
171
 
        --url-size 1019758 --url-md5 fd1f70e5262180924f1f741f8abf79b7
172
 
 
173
 
    usn.py 497-1 --release feisty --arch sparc \
174
 
        --url http://security.ubuntu.com/ubuntu/pool/main/x/xfce4-terminal/xfce4-terminal_0.2.6-0ubuntu3.1_sparc.deb \
175
 
        --url-size 1012044 --url-md5 3539fef005cc32fa15e331870b3313bb
176
 
 
177
 
 
178
 
Templates
179
 
---------
180
 
 
181
 
Templates must be provided in the Genshi 0.5+ format, as described in the
182
 
website at:
183
 
 
184
 
    http://genshi.edgewall.org/wiki/Documentation/index.html
185
 
 
186
 
Both, text and XML markup are supported.  The template format is picked
187
 
automatically.  If the first non-space character of the file is '<' and
188
 
the last non-space character is '>', it will be considered a XML file.
189
 
 
190
 
To render a template just run a command like:
191
 
 
192
 
    usn.py 497-1 --template templates/standard.txt