2 * Copyright (c) 2003-2007 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "cpio_platform.h"
29 __FBSDID("$FreeBSD$");
52 * Short options for cpio. Please keep this sorted.
54 static const char *short_options = "0AaBC:cdE:F:f:H:hI:iJjLlmnO:opR:rtuVvW:yZz";
57 * Long options for cpio. Please keep this sorted.
59 static const struct option {
61 int required; /* 1 if this option requires an argument */
62 int equivalent; /* Equivalent short option. */
64 { "b64encode", 0, OPTION_B64ENCODE },
66 { "dereference", 0, 'L' },
68 { "extract", 0, 'i' },
71 { "grzip", 0, OPTION_GRZIP },
73 { "insecure", 0, OPTION_INSECURE },
76 { "lrzip", 0, OPTION_LRZIP },
77 { "lz4", 0, OPTION_LZ4 },
78 { "lzma", 0, OPTION_LZMA },
79 { "lzop", 0, OPTION_LZOP },
80 { "make-directories", 0, 'd' },
81 { "no-preserve-owner", 0, OPTION_NO_PRESERVE_OWNER },
83 { "numeric-uid-gid", 0, 'n' },
85 { "passphrase", 1, OPTION_PASSPHRASE },
86 { "pass-through", 0, 'p' },
87 { "preserve-modification-time", 0, 'm' },
88 { "preserve-owner", 0, OPTION_PRESERVE_OWNER },
89 { "quiet", 0, OPTION_QUIET },
90 { "unconditional", 0, 'u' },
91 { "uuencode", 0, OPTION_UUENCODE },
92 { "verbose", 0, 'v' },
93 { "version", 0, OPTION_VERSION },
95 { "zstd", 0, OPTION_ZSTD },
100 * I used to try to select platform-provided getopt() or
101 * getopt_long(), but that caused a lot of headaches. In particular,
102 * I couldn't consistently use long options in the test harness
103 * because not all platforms have getopt_long(). That in turn led to
104 * overuse of the -W hack in the test harness, which made it rough to
105 * run the test harness against GNU cpio. (I periodically run the
106 * test harness here against GNU cpio as a sanity-check. Yes,
107 * I've found a couple of bugs in GNU cpio that way.)
110 cpio_getopt(struct cpio *cpio)
112 enum { state_start = 0, state_next_word, state_short, state_long };
113 static int state = state_start;
114 static char *opt_word;
116 const struct option *popt, *match = NULL, *match2 = NULL;
117 const char *p, *long_prefix = "--";
122 cpio->argument = NULL;
124 /* First time through, initialize everything. */
125 if (state == state_start) {
126 /* Skip program name. */
129 state = state_next_word;
133 * We're ready to look at the next word in argv.
135 if (state == state_next_word) {
136 /* No more arguments, so no more options. */
137 if (cpio->argv[0] == NULL)
139 /* Doesn't start with '-', so no more options. */
140 if (cpio->argv[0][0] != '-')
142 /* "--" marks end of options; consume it and return. */
143 if (strcmp(cpio->argv[0], "--") == 0) {
148 /* Get next word for parsing. */
149 opt_word = *cpio->argv++;
151 if (opt_word[1] == '-') {
152 /* Set up long option parser. */
154 opt_word += 2; /* Skip leading '--' */
156 /* Set up short option parser. */
158 ++opt_word; /* Skip leading '-' */
163 * We're parsing a group of POSIX-style single-character options.
165 if (state == state_short) {
166 /* Peel next option off of a group of short options. */
169 /* End of this group; recurse to get next option. */
170 state = state_next_word;
171 return cpio_getopt(cpio);
174 /* Does this option take an argument? */
175 p = strchr(short_options, opt);
181 /* If it takes an argument, parse that. */
183 /* If arg is run-in, opt_word already points to it. */
184 if (opt_word[0] == '\0') {
185 /* Otherwise, pick up the next word. */
186 opt_word = *cpio->argv;
187 if (opt_word == NULL) {
189 "Option -%c requires an argument",
198 long_prefix = "-W "; /* For clearer errors. */
200 state = state_next_word;
201 cpio->argument = opt_word;
206 /* We're reading a long option, including -W long=arg convention. */
207 if (state == state_long) {
208 /* After this long option, we'll be starting a new word. */
209 state = state_next_word;
211 /* Option name ends at '=' if there is one. */
212 p = strchr(opt_word, '=');
214 optlength = (size_t)(p - opt_word);
215 cpio->argument = (char *)(uintptr_t)(p + 1);
217 optlength = strlen(opt_word);
220 /* Search the table for an unambiguous match. */
221 for (popt = cpio_longopts; popt->name != NULL; popt++) {
222 /* Short-circuit if first chars don't match. */
223 if (popt->name[0] != opt_word[0])
225 /* If option is a prefix of name in table, record it.*/
226 if (strncmp(opt_word, popt->name, optlength) == 0) {
227 match2 = match; /* Record up to two matches. */
229 /* If it's an exact match, we're done. */
230 if (strlen(popt->name) == optlength) {
231 match2 = NULL; /* Forget the others. */
237 /* Fail if there wasn't a unique match. */
240 "Option %s%s is not supported",
241 long_prefix, opt_word);
244 if (match2 != NULL) {
246 "Ambiguous option %s%s (matches --%s and --%s)",
247 long_prefix, opt_word, match->name, match2->name);
251 /* We've found a unique match; does it need an argument? */
252 if (match->required) {
253 /* Argument required: get next word if necessary. */
254 if (cpio->argument == NULL) {
255 cpio->argument = *cpio->argv;
256 if (cpio->argument == NULL) {
258 "Option %s%s requires an argument",
259 long_prefix, match->name);
266 /* Argument forbidden: fail if there is one. */
267 if (cpio->argument != NULL) {
269 "Option %s%s does not allow an argument",
270 long_prefix, match->name);
274 return (match->equivalent);
282 * Parse the argument to the -R or --owner flag.
284 * The format is one of the following:
285 * <username|uid> - Override user but not group
286 * <username>: - Override both, group is user's default group
287 * <uid>: - Override user but not group
288 * <username|uid>:<groupname|gid> - Override both
289 * :<groupname|gid> - Override group but not user
291 * Where uid/gid are decimal representations and groupname/username
292 * are names to be looked up in system database. Note that we try
293 * to look up an argument as a name first, then try numeric parsing.
295 * A period can be used instead of the colon.
297 * Sets uid/gid return as appropriate, -1 indicates uid/gid not specified.
298 * TODO: If the spec uses uname/gname, then return those to the caller
299 * as well. If the spec provides uid/gid, just return names as NULL.
301 * Returns NULL if no error, otherwise returns error string for display.
305 owner_parse(const char *spec, int *uid, int *gid)
307 static char errbuff[128];
308 const char *u, *ue, *g;
314 return ("Invalid empty user/group spec");
317 * Split spec into [user][:.][group]
318 * u -> first char of username, NULL if no username
319 * ue -> first char after username (colon, period, or \0)
320 * g -> first char of group name
322 if (*spec == ':' || *spec == '.') {
323 /* If spec starts with ':' or '.', then just group. */
327 /* Otherwise, [user] or [user][:] or [user][:][group] */
329 while (*ue != ':' && *ue != '.' && *ue != '\0')
332 if (*g != '\0') /* Skip : or . to find first char of group. */
337 /* Look up user: ue is first char after end of user. */
339 struct passwd *pwent;
341 user = (char *)malloc(ue - u + 1);
343 return ("Couldn't allocate memory");
344 memcpy(user, u, ue - u);
346 if ((pwent = getpwnam(user)) != NULL) {
347 *uid = pwent->pw_uid;
349 *gid = pwent->pw_gid;
353 *uid = (int)strtoul(user, &end, 10);
354 if (errno || *end != '\0') {
355 snprintf(errbuff, sizeof(errbuff),
356 "Couldn't lookup user ``%s''", user);
357 errbuff[sizeof(errbuff) - 1] = '\0';
367 if ((grp = getgrnam(g)) != NULL) {
372 *gid = (int)strtoul(g, &end, 10);
373 if (errno || *end != '\0') {
374 snprintf(errbuff, sizeof(errbuff),
375 "Couldn't lookup group ``%s''", g);
376 errbuff[sizeof(errbuff) - 1] = '\0';