1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /******************************************************************************
18 ******************************************************************************
19 * NOTE! This program is not safe as a setuid executable! Do not make it
21 ******************************************************************************
22 *****************************************************************************/
24 * htpasswd.c: simple program for manipulating password file for
25 * the Apache HTTP server
27 * Originally by Rob McCool
31 * 1: Failure; file access/permission problem
32 * 2: Failure; command line syntax problem (usage message issued)
33 * 3: Failure; password verification failure
34 * 4: Failure; operation interrupted (such as with CTRL/C)
35 * 5: Failure; buffer would overflow (username, filename, or computed
37 * 6: Failure; username contains illegal or reserved characters
38 * 7: Failure; file is not a valid htpasswd file
41 #include "passwd_common.h"
42 #include "apr_signal.h"
43 #include "apr_getopt.h"
64 #define unlink _unlink
67 #define APHTP_NEWFILE 1
68 #define APHTP_NOFILE 2
69 #define APHTP_DELUSER 4
71 apr_file_t *ftemp = NULL;
73 static int mkrecord(struct passwd_ctx *ctx, char *user)
75 char hash_str[MAX_STRING_LEN];
78 ctx->out_len = sizeof(hash_str);
84 ctx->out = apr_pstrcat(ctx->pool, user, ":", hash_str, NL, NULL);
85 if (strlen(ctx->out) >= MAX_STRING_LEN) {
86 ctx->errstr = "resultant record too long";
92 static void usage(void)
94 apr_file_printf(errfile, "Usage:" NL
95 "\thtpasswd [-cmdpsD] passwordfile username" NL
96 "\thtpasswd -b[cmdpsD] passwordfile username password" NL
98 "\thtpasswd -n[mdps] username" NL
99 "\thtpasswd -nb[mdps] username password" NL
100 " -c Create a new file." NL
101 " -n Don't update file; display results on stdout." NL
102 " -m Force MD5 encryption of the password (default)." NL
103 " -d Force CRYPT encryption of the password (8 chars max, "
105 " -p Do not encrypt the password (plaintext, insecure)." NL
106 " -s Force SHA encryption of the password (insecure)." NL
107 " -b Use the password from the command line rather than prompting "
109 " -D Delete the specified user." NL
110 "On other systems than Windows and NetWare the '-p' flag will "
111 "probably not work." NL
112 "The SHA algorithm does not use a salt and is less secure than the "
119 * Check to see if the specified file can be opened for the given
122 static int accessible(apr_pool_t *pool, char *fname, int mode)
124 apr_file_t *f = NULL;
126 if (apr_file_open(&f, fname, mode, APR_OS_DEFAULT, pool) != APR_SUCCESS) {
134 * Return true if the named file exists, regardless of permissions.
136 static int exists(char *fname, apr_pool_t *pool)
141 check = apr_stat(&sbuf, fname, APR_FINFO_TYPE, pool);
142 return ((check || sbuf.filetype != APR_REG) ? 0 : 1);
145 static void terminate(void)
153 static void check_args(int argc, const char *const argv[],
154 struct passwd_ctx *ctx, int *mask, char **user,
164 apr_pool_t *pool = ctx->pool;
166 rv = apr_getopt_init(&state, pool, argc, argv);
167 if (rv != APR_SUCCESS)
170 while ((rv = apr_getopt(state, "cnmspdBbDiC:", &opt, &opt_arg)) == APR_SUCCESS) {
173 *mask |= APHTP_NEWFILE;
177 *mask |= APHTP_NOFILE;
180 *mask |= APHTP_DELUSER;
183 ret = parse_common_options(ctx, opt, opt_arg);
185 apr_file_printf(errfile, "%s: %s" NL, argv[0], ctx->errstr);
190 if (ctx->passwd_src == PW_ARG)
195 if ((*mask & APHTP_NEWFILE) && (*mask & APHTP_NOFILE)) {
196 apr_file_printf(errfile, "%s: -c and -n options conflict" NL, argv[0]);
199 if ((*mask & APHTP_NEWFILE) && (*mask & APHTP_DELUSER)) {
200 apr_file_printf(errfile, "%s: -c and -D options conflict" NL, argv[0]);
203 if ((*mask & APHTP_NOFILE) && (*mask & APHTP_DELUSER)) {
204 apr_file_printf(errfile, "%s: -n and -D options conflict" NL, argv[0]);
208 * Make sure we still have exactly the right number of arguments left
209 * (the filename, the username, and possibly the password if -b was
213 if ((argc - i) != args_left) {
217 if (!(*mask & APHTP_NOFILE)) {
218 if (strlen(argv[i]) > (APR_PATH_MAX - 1)) {
219 apr_file_printf(errfile, "%s: filename too long" NL, argv[0]);
222 *pwfilename = apr_pstrdup(pool, argv[i++]);
224 if (strlen(argv[i]) > (MAX_STRING_LEN - 1)) {
225 apr_file_printf(errfile, "%s: username too long (> %d)" NL,
226 argv[0], MAX_STRING_LEN - 1);
229 *user = apr_pstrdup(pool, argv[i++]);
230 if ((arg = strchr(*user, ':')) != NULL) {
231 apr_file_printf(errfile, "%s: username contains illegal "
232 "character '%c'" NL, argv[0], *arg);
235 if (ctx->passwd_src == PW_ARG) {
236 if (strlen(argv[i]) > (MAX_STRING_LEN - 1)) {
237 apr_file_printf(errfile, "%s: password too long (> %d)" NL,
238 argv[0], MAX_STRING_LEN);
241 ctx->passwd = apr_pstrdup(pool, argv[i]);
246 * Let's do it. We end up doing a lot of file opening and closing,
247 * but what do we care? This application isn't run constantly.
249 int main(int argc, const char * const argv[])
251 apr_file_t *fpw = NULL;
252 const char *errstr = NULL;
253 char line[MAX_STRING_LEN];
254 char *pwfilename = NULL;
256 char tn[] = "htpasswd.tmp.XXXXXX";
258 char *scratch, cp[MAX_STRING_LEN];
263 int existing_file = 0;
264 struct passwd_ctx ctx = { 0 };
265 #if APR_CHARSET_EBCDIC
267 apr_xlate_t *to_ascii;
270 apr_app_initialize(&argc, &argv, NULL);
272 apr_pool_create(&pool, NULL);
273 apr_file_open_stderr(&errfile, pool);
277 #if APR_CHARSET_EBCDIC
278 rv = apr_xlate_open(&to_ascii, "ISO-8859-1", APR_DEFAULT_CHARSET, pool);
280 apr_file_printf(errfile, "apr_xlate_open(to ASCII)->%d" NL, rv);
283 rv = apr_SHA1InitEBCDIC(to_ascii);
285 apr_file_printf(errfile, "apr_SHA1InitEBCDIC()->%d" NL, rv);
288 rv = apr_MD5InitEBCDIC(to_ascii);
290 apr_file_printf(errfile, "apr_MD5InitEBCDIC()->%d" NL, rv);
293 #endif /*APR_CHARSET_EBCDIC*/
295 check_args(argc, argv, &ctx, &mask, &user, &pwfilename);
298 * Only do the file checks if we're supposed to frob it.
300 if (!(mask & APHTP_NOFILE)) {
301 existing_file = exists(pwfilename, pool);
304 * Check that this existing file is readable and writable.
306 if (!accessible(pool, pwfilename, APR_FOPEN_READ|APR_FOPEN_WRITE)) {
307 apr_file_printf(errfile, "%s: cannot open file %s for "
308 "read/write access" NL, argv[0], pwfilename);
314 * Error out if -c was omitted for this non-existant file.
316 if (!(mask & APHTP_NEWFILE)) {
317 apr_file_printf(errfile,
318 "%s: cannot modify file %s; use '-c' to create it" NL,
319 argv[0], pwfilename);
323 * As it doesn't exist yet, verify that we can create it.
325 if (!accessible(pool, pwfilename, APR_FOPEN_WRITE|APR_FOPEN_CREATE)) {
326 apr_file_printf(errfile, "%s: cannot create file %s" NL,
327 argv[0], pwfilename);
334 * All the file access checks (if any) have been made. Time to go to work;
335 * try to create the record for the username in question. If that
336 * fails, there's no need to waste any time on file manipulations.
337 * Any error message text is returned in the record buffer, since
338 * the mkrecord() routine doesn't have access to argv[].
340 if (!(mask & APHTP_DELUSER)) {
341 i = mkrecord(&ctx, user);
343 apr_file_printf(errfile, "%s: %s" NL, argv[0], errstr);
346 if (mask & APHTP_NOFILE) {
347 printf("%s" NL, ctx.out);
353 * We can access the files the right way, and we have a record
354 * to add or update. Let's do it..
356 if (apr_temp_dir_get((const char**)&dirname, pool) != APR_SUCCESS) {
357 apr_file_printf(errfile, "%s: could not determine temp dir" NL,
361 dirname = apr_psprintf(pool, "%s/%s", dirname, tn);
363 if (apr_file_mktemp(&ftemp, dirname, 0, pool) != APR_SUCCESS) {
364 apr_file_printf(errfile, "%s: unable to create temporary file %s" NL,
370 * If we're not creating a new file, copy records from the existing
371 * one to the temporary file until we find the specified user.
373 if (existing_file && !(mask & APHTP_NEWFILE)) {
374 if (apr_file_open(&fpw, pwfilename, APR_READ | APR_BUFFERED,
375 APR_OS_DEFAULT, pool) != APR_SUCCESS) {
376 apr_file_printf(errfile, "%s: unable to read file %s" NL,
377 argv[0], pwfilename);
380 while (apr_file_gets(line, sizeof(line), fpw) == APR_SUCCESS) {
385 while (apr_isspace(*scratch)) {
389 if (!*scratch || (*scratch == '#')) {
390 putline(ftemp, line);
394 * See if this is our user.
396 colon = strchr(scratch, ':');
402 * If we've not got a colon on the line, this could well
403 * not be a valid htpasswd file.
404 * We should bail at this point.
406 apr_file_printf(errfile, "%s: The file %s does not appear "
407 "to be a valid htpasswd file." NL,
408 argv[0], pwfilename);
412 if (strcmp(user, scratch) != 0) {
413 putline(ftemp, line);
417 if (!(mask & APHTP_DELUSER)) {
418 /* We found the user we were looking for.
419 * Add him to the file.
421 apr_file_printf(errfile, "Updating ");
422 putline(ftemp, ctx.out);
426 /* We found the user we were looking for.
427 * Delete them from the file.
429 apr_file_printf(errfile, "Deleting ");
436 if (!found && !(mask & APHTP_DELUSER)) {
437 apr_file_printf(errfile, "Adding ");
438 putline(ftemp, ctx.out);
440 else if (!found && (mask & APHTP_DELUSER)) {
441 apr_file_printf(errfile, "User %s not found" NL, user);
444 apr_file_printf(errfile, "password for user %s" NL, user);
446 /* The temporary file has all the data, just copy it to the new location.
448 if (apr_file_copy(dirname, pwfilename, APR_FILE_SOURCE_PERMS, pool) !=
450 apr_file_printf(errfile, "%s: unable to update file %s" NL,
451 argv[0], pwfilename);
454 apr_file_close(ftemp);