summaryrefslogtreecommitdiffstats
path: root/bin/gen-DSA
blob: 2e47b58e35d165ab987ee859e9f0a1bef5d85c8e (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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
#!/bin/sh

####################
#    Copyright (C) 2011, 2012, 2013, 2014 by Raphael Geissert <geissert@debian.org>
#
#
#    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 of the License, 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 file.  If not, see <https://www.gnu.org/licenses/>.
####################

set -e

IDMODE=DSA
case "$(basename "$0")" in
    *gen-*)
	IDMODE=${0#*gen-}
    ;;
esac

if ! command -v jq >/dev/null ; then
    echo "error: jq is needed to parse distributions, please install it"
    exit 1
fi

RELEASES=`jq -r '.distributions | to_entries[] | select(.value.release) | .value.release | ascii_upcase' data/config.json`
CODENAMES=`jq -r '.distributions | to_entries[] | select(.value.release) | .key' data/config.json`

while read dist; do
    read codename
    eval $dist=$codename
done << EOF
`jq -r '.distributions | to_entries[] | select(.value.release) | (.value.release | ascii_upcase), .key' data/config.json`
EOF

NAME_SPACING=24
DATE_SPACING=22

export LC_ALL=C

[ -f doc/$IDMODE.template ] || {
    echo "error: call this script from the root of the repository" >&2
    exit 1
}

[ $# -ge 1 ] || {
    echo "usage: $0 [--save] [--embargoed|--unembargo] [$IDMODE] package[.changes] [regression] [cve(s) [bugnumber(s)]] "
    echo "       '$IDMODE' is the $IDMODE number, required when issuing a revision"
    echo "       'cve(s)' and 'bugnumber(s)' can be passed in any order but"
    echo "         always AFTER the description"
    echo ""
    echo "       When specifying package.changes the package name, version, additional bug(s) and cve(s)"
    echo "       are parsed from the .changes file."
    echo ""
    echo "       If it doesn't like your bug number, prefix it with # and report"
    exit 1
} >&2

save=false
if [ "$1" = "--save" ]; then
    save=true
    shift
fi

embargoed=false
if [ "$1" = "--embargoed" ]; then
    embargoed=true
    shift
fi

unembargo=false
if [ "$1" = "--unembargo" ]; then
    unembargo=true
    shift
    set -- "$1"
fi

toupper() {
    printf '%s' "$1" | tr '[:lower:]' '[:upper:]'
}

tolower() {
    printf '%s' "$1" | tr '[:upper:]' '[:lower:]'
}

split_n_sort() {
    printf '%s' "$1" | sed -r 's/[ ,;]+/ /g;s/^ //' | tr ' ' "\n" | sort -u |
    sort ${2:--n} | tr "\n" ' ' | sed -r 's/\s+/ /g;s/\s$//'
}

_d_space() {
    local direction="$1" text="$2" to_length="$3"
    local right='' left='' output='' spacing=0

    if [ "$direction" = 'right' ]; then
	right=' '
    elif [ "$direction" = 'left' ]; then
	left=' '
    else
	echo FIXME >&2
	exit 1
    fi

    spacing=$(($to_length-${#text}))
    output="$text"
    while [ $spacing -gt 0 ]; do
	output="${left}${output}${right}"
	spacing=$((spacing-1))
    done
    printf '%s' "$output"
}

left_space() {
    _d_space left "$@"
}

right_space() {
    _d_space right "$@"
}

warn() {
    printf "${YELLOW}warning:${NORMAL} %s\n" "$1"
}

notice() {
    printf "${MAGENTA}notice:${NORMAL} %s\n" "$1"
}

error() {
    printf "${RED}error:${NORMAL} %s\n" "$1"
}

setvar() {
    local var="$1" value="$2"

    if [ -z "$value" ]; then
	value="$(eval 'printf "%s" "$'"$var"'"')"
    fi

    sed -i "s=\$$var=$value=g" "$tmpf"
}

if command -v tput >/dev/null; then
    RED=$(tput setaf 1)
    YELLOW=$(tput setaf 3)
    MAGENTA=$(tput setaf 5)
    NORMAL=$(tput op)
else
    RED=''
    YELLOW=''
    MAGENTA=''
    NORMAL=''
fi

DAID=
if printf '%s' "$1" | grep -Eq '^('"$IDMODE"'-|)[0-9]+(-[0-9]+|)$'; then
    DAID="${1#$IDMODE-}"
    shift
fi

PACKAGE=
CHANGES=

if echo "$1" | grep -q '_.*\.changes$'; then
    CHANGES="$1"
    PACKAGE=$(awk '/^Source: / {print $2}' $CHANGES)
else
    PACKAGE="$(tolower "$1")"
fi

shift

TYPE=security
if [ regression = "$1" ]; then
    TYPE=regression
    shift
fi

CVE=
BUGNUM=
REFERENCES=0
TEXT=

while [ $# -gt 0 ]; do
    case "$1" in
	[cC][vV][eE]-*)
	    CVE="$CVE $(toupper "$1")"
	;;
	[0-9][0-9][0-9][0-9][0-9][0-9]|[#][0-9]*)
	    BUGNUM="$BUGNUM ${1#\#}"
	;;
	*)
	    error "Don't know what to do with '$1' argument" >&2
	    exit 1
	;;
    esac
    shift
done

if ! [ -z "$CHANGES" ]; then
    # parse info from .changes file
    # Version can occur in GPG signature, thus we exit on first occurence
    version="$(awk '/^Version: / {print $2; exit 0}' $CHANGES)"
    dist="$(awk '/^Distribution: / {print $2}' $CHANGES | sed 's/-.*//')"
    export ${dist}_VERSION="$version"

    for bug in $(awk '/^Closes: / {sub(".*"$2,$2); print $0}' $CHANGES); do
        BUGNUM="$BUGNUM ${bug#\#}"
    done
    for cve in $(awk 'BEGIN {RS="[ ().,:;\n\\[\\]]" } /^CVE-[0-9]+-[0-9]+$/ {print $1}' $CHANGES); do
        CVE="$CVE $cve"
    done
fi

BUGNUM="$(split_n_sort "$BUGNUM")"

CVE="$(split_n_sort "$CVE" -V)"
cve_spacing="$(right_space '' 17)"

sed_cmd='s/((CVE-[0-9-]+[ ]+){4})/\1\\n'"$cve_spacing"'/g;P;D'
CVE_LIST="$(printf '%s' "$CVE" | sed -r "$sed_cmd")"

for id in $CVE; do
    REFERENCES=$(($REFERENCES+1))
    grep -wq "^$id" data/CVE/list || {
	warn "'$id' is not known" >&2
    }

    TEXT="$TEXT\n\n$id\n\n    Description"
done

if [ $REFERENCES -eq 1 ]; then
    TEXT=
fi

if [ -n "$TEXT" ]; then
    TEXT="Brief introduction $TEXT"
    
    if ! $save; then
	TEXT="The CVE ids will be listed here when --save'ing"
    fi
fi

case "$DAID" in
    *-*|'')
	:
    ;;
    *)
	notice "missing $IDMODE revision number, assuming 1" >&2
	DAID="$DAID-1"
    ;;
esac

daid_exists() {
    grep -wq "$IDMODE-$1" data/$IDMODE/list
}

if $embargoed; then
    DAID=EMBRGD-"$PACKAGE"
fi

if [ -z "$DAID" ]; then
    if [ "$TYPE" = regression ]; then
	latest_daid="$(sed -nr '/'"$IDMODE"'-[0-9]+-[0-9]+'" $PACKAGE "'/{s/^.+'"$IDMODE"'-[0]*([0-9-]+).*$/\1/;p;q}' data/$IDMODE/list)"
	revision=${latest_daid#*-}
	daid=${latest_daid%-*}
    else
	latest_daid="$(sed -nr '/'"$IDMODE"'-[0-9]+-1/{s/^.+'"$IDMODE"'-[0]*([0-9]+).*$/\1/;p;q}' data/$IDMODE/list)"
	daid=$(($latest_daid+1))
	revision=1
    fi

    c=0
    while daid_exists "$daid-$revision"; do
	if [ "$TYPE" = regression ]; then
	    revision=$(($revision+1))
	else
	    daid=$(($daid+1))
	fi
	c=$(($c+1))
	if [ $c -eq 10 ]; then
	    error "unable to find an unused $IDMODE id after $c attempts" >&2
	    error "to workaround specify an id as the first parameter" >&2
	    exit 1
	fi
    done
    DAID="$daid-$revision"
fi

if daid_exists "$DAID"; then
    error "$IDMODE-$DAID has already been used" >&2
    exit 1
fi

if $unembargo; then
    EMBRGD_ID="EMBRGD-$PACKAGE"
    mv "$IDMODE-${EMBRGD_ID}" $IDMODE-"$DAID"

    # get the date of when the embargoed entry was generated
    gen_date="$(sed -rn "/$IDMODE-${EMBRGD_ID}/{s/^\[(.+)\].+$/\1/;p;t}" data/$IDMODE/list)"

    OLD_DATE="$(date -d "$gen_date" +"%B %d, %Y")"
    OLD_SPACEDDATE="$(right_space "$OLD_DATE" "$DATE_SPACING")"

    NEW_DATE="$(date +"%B %d, %Y")"
    NEW_SPACEDDATE="$(right_space "$NEW_DATE" "$DATE_SPACING")"

    sed -ri "/$IDMODE-${EMBRGD_ID}/{s/\[.+\]/[$(date +"%d %b %Y")]/;s/$IDMODE-${EMBRGD_ID}/$IDMODE-$DAID/;}" data/$IDMODE/list
    sed -i "s/${EMBRGD_ID}/$DAID/g" $IDMODE-"$DAID"
    sed -i "s/^$OLD_SPACEDDATE/$NEW_SPACEDDATE/" $IDMODE-"$DAID"

    echo "'Unembargoing' as $IDMODE-$DAID"
    exit
fi

tmpf=$(mktemp)
cat doc/$IDMODE.template > $tmpf

if [ "$TYPE" = regression ]; then
    sed -ri '/^Subject:/s/security update$/regression update/' $tmpf
fi

if [ $REFERENCES -gt 1 ]; then
    sed -ri 's/this problem has/these problems have/' $tmpf
fi

if [ -z "$DEBFULLNAME" ]; then
    "error: DEBFULLNAME env variable required"
    exit 1
fi
SPACEDDEBFULLNAME="$(left_space "$DEBFULLNAME" "$NAME_SPACING")"

DATE="$(date +"%B %d, %Y")"
SPACEDDATE="$(right_space "$DATE" "$DATE_SPACING")"

setvar DEBEMAIL
setvar DEBFULLNAME
setvar SPACEDDEBFULLNAME
setvar PACKAGE
setvar CVE "$CVE_LIST"
setvar ${IDMODE}ID "$DAID"
setvar BUGNUM
setvar SPACEDDATE
setvar DATE
setvar TEXT "${TEXT:-$IDMODE text goes here}"

for dist in $RELEASES; do
    setvar $dist
done

for dist in $CODENAMES; do
    version="$(eval 'printf "%s" "$'"$dist"_VERSION'"')"
    if $save && [ -z "$version" ] && grep -q "${dist}_VERSION" "$tmpf"; then
	printf "Enter $dist's version [unset]: "
	read version
	if [ -n "$version" ]; then
	    eval "${dist}_VERSION='$version'"
	fi
    fi
    [ -z "$version" ] || setvar "${dist}_VERSION" "$version"
    [ -z "$version" ] || bin/remove-cve-dist-tags "${dist}" "${PACKAGE}" ${CVE}
done

if ! $save; then
    cat $tmpf
    echo
    echo " ---- "
    echo "Pass --save as the first parameter to save the text to $IDMODE-$DAID"
    echo "(the data/$IDMODE/list entry will also be added)"
    rm -f "$tmpf"
    exit
else
    mv -i $tmpf "$IDMODE-$DAID" || { rm -f $tmpf; exit; }

    needed_file=data/"$(tolower "$IDMODE")"-needed.txt

    daid_entry=$(mktemp)
    cat <<EOF > $daid_entry
[$(date +"%d %b %Y")] $IDMODE-$DAID $PACKAGE - $TYPE update
EOF

    if [ "$CVE" ]; then
	printf "\t{%s}\n" "$CVE" >> $daid_entry
    fi

    for dist in $CODENAMES; do
	version="$(eval 'printf "%s" "$'"$dist"_VERSION'"')"
	[ -z "$version" ] || \
	    printf "\t[%s] - %s %s\n" "$dist" "$PACKAGE" "$version" >> $daid_entry
    done
    tmp_list="$(mktemp)"
    cat $daid_entry data/$IDMODE/list > $tmp_list
    cat $tmp_list > data/$IDMODE/list
    rm -f $tmp_list
    sed -rn '/^'"$PACKAGE"'(\/\w+)?(\s.*|$)\b/{: next;n;/^\s/b next;d};p' $needed_file > $needed_file.new
    mv $needed_file.new $needed_file
    echo "$IDMODE text written to ./$IDMODE-$DAID"
    if [ "$IDMODE" = "DLA" ] || [ "$IDMODE" = "ELA" ]; then
	idmode=$(echo "$IDMODE" | tr A-Z a-z)
	if [ -d .git ]; then
	    echo "Made the following changes:"
	    git diff -- data/$IDMODE/list $needed_file
	    if ! git diff-index --name-only HEAD -- $needed_file | grep -qs . && [ $TYPE = security ]; then
		warn "did not make any changes to $needed_file - this may indicate duplicate work or misspelled package name"
	    fi
	fi
	warn "you need to commit and push the changes to data/$IDMODE/list etc. to actually reserve the $IDMODE-$DAID number and avoid conflicts with others."
	if [ -d .git ]; then
	    echo -n "Do you want to commit and push them now ? [Yn] "
	    read reply
	    if [ "$reply" = "Y" ] || [ "$reply" = "" ] || [ "$reply" = "y" ]; then
		git add data/$IDMODE/list $needed_file
		git commit -m "Reserve $IDMODE-$DAID for $PACKAGE"
		git push origin master
	    fi
	fi
    fi
fi

© 2014-2024 Faster IT GmbH | imprint | privacy policy