Author: stsp
Date: Wed Jul 3 20:02:02 2013
New Revision: 1499541
URL: http://svn.apache.org/r1499541
Log:
Add a prelimenary version of a new 'svnauth' tool.
This tool will manage the authentication credentials cache.
Currently, svnauth supports listing available cache types (svnauth --version)
and listing cached credentials (svnauth list). The list of credentials is
not formatted nicely yet. I hope to improve this soon.
Support for removing cached credentials will be added later, too.
I'd also like to add support for listing cached client and server SSL
certificates in a useful way, and allow to delete them.
* build.conf: Add svnauth.
* subversion/svnauth: New directory.
* subversion/svnauth/svnauth.1: New man page. Based on svnadmin man page.
* subversion/svnauth/svnauth.c: New tool. Code partly based on svn and svnadmin.
Added:
subversion/trunk/subversion/svnauth/ (with props)
subversion/trunk/subversion/svnauth/svnauth.1 (with props)
subversion/trunk/subversion/svnauth/svnauth.c (with props)
Modified:
subversion/trunk/build.conf
Modified: subversion/trunk/build.conf
URL:
http://svn.apache.org/viewvc/subversion/trunk/build.conf?rev=1499541&r1=1499540&r2=1499541&view=diff
==============================================================================
--- subversion/trunk/build.conf (original)
+++ subversion/trunk/build.conf Wed Jul 3 20:02:02 2013
@@ -198,6 +198,14 @@ libs = libsvn_client libsvn_ra libsvn_su
install = bin
manpages = subversion/svnmucc/svnmucc.1
+[svnauth]
+description = Subversion Auth Creds Management Tool
+type = exe
+path = subversion/svnauth
+libs = libsvn_subr apriconv apr
+install = bin
+manpages = subversion/svnauth/svnauth.1
+
# Support for GNOME Keyring
[libsvn_auth_gnome_keyring]
description = Subversion GNOME Keyring Library
Propchange: subversion/trunk/subversion/svnauth/
------------------------------------------------------------------------------
--- svn:ignore (added)
+++ svn:ignore Wed Jul 3 20:02:02 2013
@@ -0,0 +1 @@
+svnauth
Added: subversion/trunk/subversion/svnauth/svnauth.1
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/svnauth/svnauth.1?rev=1499541&view=auto
==============================================================================
--- subversion/trunk/subversion/svnauth/svnauth.1 (added)
+++ subversion/trunk/subversion/svnauth/svnauth.1 Wed Jul 3 20:02:02 2013
@@ -0,0 +1,47 @@
+.\"
+.\"
+.\" Licensed to the Apache Software Foundation (ASF) under one
+.\" or more contributor license agreements. See the NOTICE file
+.\" distributed with this work for additional information
+.\" regarding copyright ownership. The ASF licenses this file
+.\" to you under the Apache License, Version 2.0 (the
+.\" "License"); you may not use this file except in compliance
+.\" with the License. You may obtain a copy of the License at
+.\"
+.\" http://www.apache.org/licenses/LICENSE-2.0
+.\"
+.\" Unless required by applicable law or agreed to in writing,
+.\" software distributed under the License is distributed on an
+.\" "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+.\" KIND, either express or implied. See the License for the
+.\" specific language governing permissions and limitations
+.\" under the License.
+.\"
+.\"
+.\" You can view this file with:
+.\" nroff -man [filename]
+.\"
+.TH svnauth 1
+.SH NAME
+svnauth \- Subversion authentication cache administration tool
+.SH SYNOPSIS
+.TP
+\fBsvnauth\fP \fIcommand\fP [\fIoptions\fP] [\fIargs\fP]
+.SH OVERVIEW
+Subversion is a version control system, which allows you to keep old
+versions of files and directories (usually source code), keep a log of
+who, when, and why changes occurred, etc., like CVS, RCS or SCCS.
+\fBSubversion\fP keeps a single copy of the master sources. This copy
+is called the source ``repository''; it contains all the information
+to permit extracting previous versions of those files at any time.
+
+For more information about the Subversion project, visit
+http://subversion.apache.org.
+
+Documentation for Subversion and its tools, including detailed usage
+explanations of the \fBsvn\fP, \fBsvnadmin\fP, \fBsvnserve\fP and
+\fBsvnlook\fP programs, historical background, philosophical
+approaches and reasonings, etc., can be found at
+http://svnbook.red-bean.com/.
+
+Run `svnauth help' to access the built-in tool documentation.
Propchange: subversion/trunk/subversion/svnauth/svnauth.1
------------------------------------------------------------------------------
svn:eol-style = native
Added: subversion/trunk/subversion/svnauth/svnauth.c
URL:
http://svn.apache.org/viewvc/subversion/trunk/subversion/svnauth/svnauth.c?rev=1499541&view=auto
==============================================================================
--- subversion/trunk/subversion/svnauth/svnauth.c (added)
+++ subversion/trunk/subversion/svnauth/svnauth.c Wed Jul 3 20:02:02 2013
@@ -0,0 +1,376 @@
+/*
+ * svnauth.c: Subversion auth creds cache administration tool
+ *
+ * ====================================================================
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ * ====================================================================
+ */
+
+/*** Includes. ***/
+
+#include <apr_general.h>
+#include <apr_getopt.h>
+#include <apr_tables.h>
+
+#include "svn_pools.h"
+#include "svn_error.h"
+#include "svn_opt.h"
+#include "svn_dirent_uri.h"
+#include "svn_utf.h"
+#include "svn_cmdline.h"
+#include "svn_config.h"
+#include "svn_auth.h"
+#include "svn_sorts.h"
+
+#include "private/svn_cmdline_private.h"
+
+#include "svn_private_config.h"
+
+/* Baton for passing option/argument state to a subcommand function. */
+struct svnauth_opt_state
+{
+ const char *config_dir; /* --config-dir */
+ svn_boolean_t version; /* --version */
+ svn_boolean_t help; /* --help */
+};
+
+typedef enum svn_cl__longopt_t {
+ opt_config_dir = SVN_OPT_FIRST_LONGOPT_ID,
+ opt_version
+} svn_cl__longopt_t;
+
+/** Subcommands. **/
+static svn_opt_subcommand_t
+ subcommand_help,
+ subcommand_list;
+
+/* Array of available subcommands.
+ * The entire list must be terminated with an entry of nulls.
+ */
+static const svn_opt_subcommand_desc2_t cmd_table[] =
+{
+ {"help", subcommand_help, {"?", "h"}, N_
+ ("usage: svnauth help [SUBCOMMAND...]\n\n"
+ "Describe the usage of this program or its subcommands.\n"),
+ {0} },
+
+ {"list", subcommand_list, {0}, N_
+ ("usage: svnauth list\n\n"
+ "List cached authentication credentials.\n"),
+ {0} },
+
+ {NULL}
+};
+
+/* Option codes and descriptions.
+ *
+ * The entire list must be terminated with an entry of nulls.
+ */
+static const apr_getopt_option_t options_table[] =
+ {
+ {"help", 'h', 0, N_("show help on a subcommand")},
+
+ {"config-dir", opt_config_dir, 1,
+ N_("use auth cache in config directory ARG")},
+
+ {"version", opt_version, 0,
+ N_("show program version information")},
+
+ {NULL}
+ };
+
+/* This implements `svn_opt_subcommand_t'. */
+static svn_error_t *
+subcommand_help(apr_getopt_t *os, void *baton, apr_pool_t *pool)
+{
+ struct svnauth_opt_state *opt_state = baton;
+ const char *header =
+ _("general usage: svnauth SUBCOMMAND [ARGS & OPTIONS ...]\n"
+ "Type 'svnauth help <subcommand>' for help on a specific subcommand.\n"
+ "Type 'svnauth --version' to see the program version and available\n"
+ "authentication credential caches.\n"
+ "\n"
+ "Available subcommands:\n");
+ const char *footer = NULL;
+
+ if (opt_state && opt_state->version)
+ {
+ const char *config_path;
+
+ SVN_ERR(svn_config_get_user_config_path(&config_path,
+ opt_state->config_dir, NULL,
+ pool));
+ footer = _("Available authentication credential caches:\n");
+
+ /*
+ * ### There is no API to query available providers at run time.
+ */
+#if (defined(WIN32) && !defined(__MINGW32__))
+ footer = apr_psprintf(pool, _("%s Wincrypt cache in %s\n"),
+ footer, config_path);
+#elif !defined(SVN_DISABLE_PLAINTEXT_PASSWORD_STORAGE)
+ footer = apr_psprintf(pool, _("%s Plaintext cache in %s\n"),
+ footer, config_path);
+#endif
+#ifdef SVN_HAVE_GNOME_KEYRING
+ footer = apr_pstrcat(pool, footer, " Gnome Keyring\n", NULL);
+#endif
+#ifdef SVN_HAVE_GPG_AGENT
+ footer = apr_pstrcat(pool, footer, " GPG-Agent\n", NULL);
+#endif
+#ifdef SVN_HAVE_KEYCHAIN_SERVICES
+ footer = apr_pstrcat(pool, footer, " Mac OS X Keychain\n", NULL);
+#endif
+#ifdef SVN_HAVE_KWALLET
+ footer = apr_pstrcat(pool, footer, " KWallet (KDE)\n", NULL);
+#endif
+ }
+
+ SVN_ERR(svn_opt_print_help4(os, "svnauth",
+ opt_state ? opt_state->version : FALSE,
+ FALSE, FALSE, footer,
+ header, cmd_table, options_table, NULL, NULL,
+ pool));
+
+ return SVN_NO_ERROR;
+}
+
+/* This implements `svn_config_auth_walk_func_t` */
+static svn_error_t *
+list_credentials(svn_boolean_t *delete_cred,
+ void *cleanup_baton,
+ const char *cred_kind,
+ const char *realmstring,
+ apr_hash_t *hash,
+ apr_pool_t *scratch_pool)
+{
+ apr_array_header_t *sorted_hash_items;
+ int i;
+
+ *delete_cred = FALSE;
+
+ SVN_ERR(svn_cmdline_printf(scratch_pool,
+ _("Credential kind: %s\n"), cred_kind));
+ SVN_ERR(svn_cmdline_printf(scratch_pool,
+ _("Authentication realm: %s\n"), realmstring));
+
+ sorted_hash_items = svn_sort__hash(hash, svn_sort_compare_items_lexically,
+ scratch_pool);
+ for (i = 0; i < sorted_hash_items->nelts; i++)
+ {
+ svn_sort__item_t item;
+ const char *key;
+ svn_string_t *value;
+
+ item = APR_ARRAY_IDX(sorted_hash_items, i, svn_sort__item_t);
+ key = item.key;
+ value = item.value;
+ SVN_ERR(svn_cmdline_printf(scratch_pool, "%s: %s\n", key, value->data));
+ }
+
+ SVN_ERR(svn_cmdline_printf(scratch_pool, "\n"));
+ return SVN_NO_ERROR;
+}
+
+
+/* This implements `svn_opt_subcommand_t'. */
+static svn_error_t *
+subcommand_list(apr_getopt_t *os, void *baton, apr_pool_t *pool)
+{
+ struct svnauth_opt_state *opt_state = baton;
+ const char *config_path;
+
+ SVN_ERR(svn_config_get_user_config_path(&config_path,
+ opt_state->config_dir, NULL,
+ pool));
+
+ SVN_ERR(svn_config_walk_auth_data(config_path, list_credentials, NULL,
+ pool));
+ return SVN_NO_ERROR;
+}
+
+
+/* Report and clear the error ERR, and return EXIT_FAILURE. */
+#define EXIT_ERROR(err) \
+ svn_cmdline_handle_exit_error(err, NULL, "svnauth: ")
+
+/* A redefinition of the public SVN_INT_ERR macro, that suppresses the
+ * error message if it is SVN_ERR_IO_PIPE_WRITE_ERROR, amd with the
+ * program name 'svnauth' instead of 'svn'. */
+#undef SVN_INT_ERR
+#define SVN_INT_ERR(expr) \
+ do { \
+ svn_error_t *svn_err__temp = (expr); \
+ if (svn_err__temp) \
+ return EXIT_ERROR(svn_err__temp); \
+ } while (0)
+
+
+static int
+sub_main(int argc, const char *argv[], apr_pool_t *pool)
+{
+ svn_error_t *err;
+ const svn_opt_subcommand_desc2_t *subcommand = NULL;
+ struct svnauth_opt_state opt_state = { 0 };
+ apr_getopt_t *os;
+
+ if (argc <= 1)
+ {
+ SVN_INT_ERR(subcommand_help(NULL, NULL, pool));
+ return EXIT_FAILURE;
+ }
+
+ /* Parse options. */
+ SVN_INT_ERR(svn_cmdline__getopt_init(&os, argc, argv, pool));
+ os->interleave = 1;
+
+ while (1)
+ {
+ int opt_id;
+ const char *opt_arg;
+ const char *utf8_opt_arg;
+ apr_status_t apr_err;
+
+ /* Parse the next option. */
+ apr_err = apr_getopt_long(os, options_table, &opt_id, &opt_arg);
+ if (APR_STATUS_IS_EOF(apr_err))
+ break;
+ else if (apr_err)
+ {
+ SVN_INT_ERR(subcommand_help(NULL, NULL, pool));
+ return EXIT_FAILURE;
+ }
+
+ switch (opt_id) {
+ case 'h':
+ case '?':
+ opt_state.help = TRUE;
+ break;
+ case opt_config_dir:
+ SVN_INT_ERR(svn_utf_cstring_to_utf8(&utf8_opt_arg, opt_arg, pool));
+ opt_state.config_dir = svn_dirent_internal_style(utf8_opt_arg, pool);
+ break;
+ case opt_version:
+ opt_state.version = TRUE;
+ break;
+ default:
+ {
+ SVN_INT_ERR(subcommand_help(NULL, NULL, pool));
+ return EXIT_FAILURE;
+ }
+ }
+ }
+
+ if (opt_state.help)
+ subcommand = svn_opt_get_canonical_subcommand2(cmd_table, "help");
+
+ /* If we're not running the `help' subcommand, then look for a
+ subcommand in the first argument. */
+ if (subcommand == NULL)
+ {
+ if (os->ind >= os->argc)
+ {
+ if (opt_state.version)
+ {
+ /* Use the "help" subcommand to handle the "--version" option. */
+ static const svn_opt_subcommand_desc2_t pseudo_cmd =
+ { "--version", subcommand_help, {0}, "",
+ {opt_version, /* must accept its own option */
+ 'q', /* --quiet */
+ } };
+
+ subcommand = &pseudo_cmd;
+ }
+ else
+ {
+ svn_error_clear(svn_cmdline_fprintf(stderr, pool,
+ _("subcommand argument required\n")));
+ SVN_INT_ERR(subcommand_help(NULL, NULL, pool));
+ return EXIT_FAILURE;
+ }
+ }
+ else
+ {
+ const char *first_arg = os->argv[os->ind++];
+ subcommand = svn_opt_get_canonical_subcommand2(cmd_table, first_arg);
+ if (subcommand == NULL)
+ {
+ const char *first_arg_utf8;
+ SVN_INT_ERR(svn_utf_cstring_to_utf8(&first_arg_utf8,
+ first_arg, pool));
+ svn_error_clear(
+ svn_cmdline_fprintf(stderr, pool,
+ _("Unknown subcommand: '%s'\n"),
+ first_arg_utf8));
+ SVN_INT_ERR(subcommand_help(NULL, NULL, pool));
+ return EXIT_FAILURE;
+ }
+ }
+ }
+
+ SVN_INT_ERR(svn_config_ensure(opt_state.config_dir, pool));
+
+ /* Run the subcommand. */
+ err = (*subcommand->cmd_func)(os, &opt_state, pool);
+ if (err)
+ {
+ /* For argument-related problems, suggest using the 'help'
+ subcommand. */
+ if (err->apr_err == SVN_ERR_CL_INSUFFICIENT_ARGS
+ || err->apr_err == SVN_ERR_CL_ARG_PARSING_ERROR)
+ {
+ err = svn_error_quick_wrap(err,
+ _("Try 'svnauth help' for more info"));
+ }
+ return EXIT_ERROR(err);
+ }
+ else
+ {
+ /* Ensure that everything is written to stdout, so the user will
+ see any print errors. */
+ err = svn_cmdline_fflush(stdout);
+ if (err)
+ {
+ return EXIT_ERROR(err);
+ }
+ return EXIT_SUCCESS;
+ }
+
+ return EXIT_SUCCESS;
+}
+
+int
+main(int argc, const char *argv[])
+{
+ apr_pool_t *pool;
+ int exit_code;
+
+ /* Initialize the app. */
+ if (svn_cmdline_init("svnauth", stderr) != EXIT_SUCCESS)
+ return EXIT_FAILURE;
+
+ /* Create our top-level pool. Use a separate mutexless allocator,
+ * given this application is single threaded.
+ */
+ pool = apr_allocator_owner_get(svn_pool_create_allocator(FALSE));
+
+ exit_code = sub_main(argc, argv, pool);
+
+ svn_pool_destroy(pool);
+ return exit_code;
+}
Propchange: subversion/trunk/subversion/svnauth/svnauth.c
------------------------------------------------------------------------------
svn:eol-style = native
