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
|
libjte internals
~~~~~~~~~~~~~~~~
See API file for the public interface.
Jigdo options for xorriso/libisoburn
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Implemented are :
-jigdo-jigdo FILE Produce a jigdo .jigdo file as well as the .iso
-jigdo-template FILE Produce a jigdo .template file as well as the .iso
-jigdo-min-file-size SIZE Minimum size for a file to be listed in the jigdo file
-jigdo-force-md5 PATTERN Pattern(s) where files MUST match an externally-supplied MD5sum
-jigdo-force-sha256 PATTERN Pattern(s) where files MUST match an externally-supplied SHA256sum
-jigdo-exclude PATTERN Pattern(s) to exclude from the jigdo file
-jigdo-map PATTERN1=PATTERN2 Pattern(s) to map paths (e.g. Debian=/mirror/debian)
-md5-list FILE File containing MD5 sums of the files that should be checked
-checksum-list FILE File containing checksums of the files that should be checked
-jigdo-template-compress ALGORITHM Choose to use gzip or bzip2 compression for template data; default is gzip
Not yet implemented:
-checksum_algorithm_iso alg1,alg2,... Specify the checksum types desired for the output image
-checksum_algorithm_template alg1,alg2,... Specify the checksum types desired for the output jigdo template
Example: xorriso/genisoimage -J -r -o /home/steve/test1.iso \
-jigdo-jigdo /home/steve/test1.jigdo \
-jigdo-template /home/steve/test1.template \
-jigdo-min-file-size 16384 \
-jigdo-exclude "README*" \
-jigdo-force-md5 "/pool/" \
-jigdo-map Debian=/mirror/debian \
-md5-list /home/steve/md5.list \
/mirror/jigdo-test
Global variables from application POV (declated in jte.h)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- extern char *jtemplate_out;
XORRISO: -jigdo-template filepath
- extern char *jjigdo_out;
XORRISO: -jigdo-jigdo filepath
- extern char *jmd5_list;
XORRISO: -md5-list filepath
- extern char *checksum_list;
XORRISO: -checksum-list filepath
XORRISO: -md5-list filepath
- extern FILE *jtjigdo;
XORRISO: handle initialized with -jigdo-jigdo filepath
- extern FILE *jttemplate;
XORRISO: resp. handle for template
- int jte_min_size;
XORRISO: -jigdo-min-file-size
- int checksum_algo_iso;
XORRISO: -checksum_algorithm_iso alg1,alg2,...
- int checksum_algo_tmpl;
XORRISO: -checksum_algorithm_template alg1,alg2,...
- jtc_t jte_template_compression (type declated in jte.h)
XORRISO: -jigdo-template-compress
Callers from the application POV (genisoimage as example)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
(all of these are called if jigdo representation is requested by the
user, i.e. path to .jigdo and .template were given via options):
- void write_jt_header(FILE *template_file, FILE *jigdo_file);
DESCRIPTION: call after .jigdo and .template file handles are opened.
PARAMETERS: obvious
XORRISO: to provide -jigdo-jigdo and -jigdo-template
- void write_jt_footer(void);
DESCRIPTION: call after image and .jigdo and .template files are complated
also do close file handles for .jigdo and .template.
PARAMETERS: none
XORRISO: calls that somewhere in finalization code?
- void jtwrite(void *buffer, int size, int count, int submode, BOOL islast);
DESCRIPTION: call that on each place where data is written to the image,
after list_file_in_jigdo() and write_jt_match_record() are called.
PARAMETERS: fairly obvious
LIBISOFS: see below in list_file_in_jigdo() section
- void write_jt_match_record(char *filename, char *mirror_name, int sector_size, off_t size, unsigned char md5[16]);
DESCRIPTION: to be called after list_file_in_jigdo() call:
int include_in_jigdo = list_file_in_jigdo()
if (include_in_jigdo)
write_jt_match_record();
...
call_to_write_data_to_image();
if (!include_in_jigdo)
jtwrite();
PARAMETERS: filename - disk file path
mirror_name - as returned previously by list_file_in_jigdo()
LIBISOFS: see below in list_file_in_jigdo() section
- void write_jt_match_record_sha256(char *filename, char *mirror_name, int sector_size, off_t size, unsigned char sha256[32]);
DESCRIPTION: to be called after list_file_in_jigdo() call:
int include_in_jigdo = list_file_in_jigdo()
if (include_in_jigdo)
write_jt_match_record();
...
call_to_write_data_to_image();
if (!include_in_jigdo)
jtwrite();
PARAMETERS: filename - disk file path
mirror_name - as returned previously by list_file_in_jigdo()
LIBISOFS: see below in list_file_in_jigdo() section
- int list_file_in_jigdo(char *filename, off_t size, char **realname, unsigned char md5[16]);
DESCRIPTION: decides whether a file should be placed in .jigdo
PARAMETERS: filename - disk file path
mirror_name - to be returned and given to write_jt_match_record()
md5[16] - We have the MD5. But ok. If it works that way then we should not
change it without need. Eventually write a new function without calling
calculate_md5sum(), but supply the md5sum instead as we already have it on that
libisofs spot.
LIBISOFS: libisofs/filesrc.c:filesrc_writer_write_data() has a loop which iterates over the
array of IsoFileSrc of all data files and writes their data content to the output stream.
- int list_file_in_jigdo_sha256(char *filename, off_t size, char **realname, unsigned char sha256[32]);
DESCRIPTION: decides whether a file should be placed in .jigdo
PARAMETERS: filename - disk file path
mirror_name - to be returned and given to write_jt_match_record()
sha256[32] - We have the SHA256. But ok. If it works that way then we should not
change it without need. Eventually write a new function without calling
calculate_sha256sum(), but supply the sha256sum instead as we already have it on that
libisofs spot.
LIBISOFS: libisofs/filesrc.c:filesrc_writer_write_data() has a loop which iterates over the
array of IsoFileSrc of all data files and writes their data content to the output stream.
- int jte_add_exclude(char *pattern);
DESCRIPTION: files matching patterns to be included in .jigdo
PARAMETERS: pattern string
XORRISO: -jigdo-exclude "README*"
- int jte_add_include(char *pattern);
DESCTIPRITON: files matching patterns to be included in .jigdo
PARAMETERS: pattern string
XORRISO: -jigdo-force-md5 "/pool/"
XORRISO: -jigdo-force-sha256 "/pool/"
- int jte_add_mapping(char *arg);
DESCRIPTION: provides String:/a/b/c mappings for [Parts] section .jigdo file
PARAMETERS: arg - Debian=/mirror/debian
XORRISO: -jigdo-map Debian=/mirror/debian
>>> Where are the argument parsers of algorithm setters ?
- libjte: MD5/SHA256, size, and basename of the path have to match
MD5/SHA256, size, and basename of the data file.
- libjte: The directory part of path is just a literal string that shall be
checked for the address mapping
-jigdo-map Debian=literal_checksum_path_start
-jigit-mkimage: The directory part of the path is of importance when producing
the payload image from template file.
- If the payload image gets generated by option -j jigdo_file, then
the disk file address of a data file gets composed from the reverse
mapping
-m Debian=/really/usable/path/for/fopen
and the parts of the path, that was not consumed by the genisoimage
mapping.
- If the payload image gets generated by option -f md5_file or -F
sha256_file, then the paths in the checksum file have to be usable
for fopen().
If we follow the mainstream and ignore the case of jigit-mkimage -f md5_file,
then we can reduce the constraint for paths in .md5 to the advise to use
absolute paths in a literally coordinated way with the jigdo generator.
|
