man/mono-configuration-crypto.1

   1 .TH Mono "mono-configuration-crypto"
   2 .SH NAME
   3 mono-configuration-crypto, \- Mono configuration utility to manage encryption keys and encrypt/decrypt config file sections
   4 .SH SYNOPSIS
   5 .B mono-configuration-crypto <options>
   6 .SH DESCRIPTION
   7 mono-configuration-crypto is a utility to manage mono encryption key container store and to encrypt/decrypt config
   8 file sections.
   9 .SH OPTIONS
  10 .TP
  11 .B -h, -?, --help
  12 Show usage information
  13
  14 .TP
  15 .B   -v, --verbose
  16 Show verbose information (including exception stacktraces)
  17
  18 .TP
  19 .B   -m, --machine, --global
  20 Use machine (global) store for all the key actions. Note that on Unix machines global store is located in
  21 \fI/usr/share/.mono\fR and modifying it requires root user permissions.
  22
  23 .TP
  24 .B   -u, --user, --local
  25 Use local (user) store for all the key actions. User key store is located in the \fI$HOME/.config/.mono\fR
  26 directory. This is the default location used by mono-configuration-crypto.
  27
  28 .TP
  29 .B   -l, --list
  30 List all the key container names in the store. Note that some container names might be just GUID strings.
  31
  32 .TP
  33 .B   -c, --create
  34 Creates an RSA public/private key pair. If the specified container (see the \fI-f\fR option) already exists, the
  35 operation will fail.
  36
  37 .TP
  38 .B   -i, --import
  39 Imports key to a container. Imports a key from file (specified by the \fI-f\fR option) and puts it as the first key
  40 in the specified container (see the \fI-n\fR option). If container exists, its first key is replaced. If container
  41 doesn't exist, it is created. No validation is performed on the key value - this is left to the protection provider or
  42 encryption code which uses the key.
  43
  44 .TP
  45 .B   -x, --export
  46 Exports key from a container. Exports a key from indicated container (see the \fI-n\fR option) and puts it in the
  47 specified file (see the \fI-f\fR option) as XML. The file can later be used to import the key.
  48
  49 .TP
  50 .B   -r, --remove
  51 Remove a container. Physically removes the container file from disk.
  52
  53 .TP
  54 .B   -f, --file=VALUE
  55 File name for import or export operations. All options which read or write anything to/from files require this option
  56 to be present on the command line.
  57
  58 .TP
  59 .B   -cf, --config-file=VALUE
  60 Config file name. Specifies base name of the config file, used in encrypt and decrypt operations. Files are sought for
  61 case-insensitively. Defaults to \fIWeb.config\fR
  62
  63 .TP
  64 .B   -n, --name=VALUE
  65 Container name. If this option is absent from the command line it defaults to \fIMonoFrameworkConfigurationKey\fR (the
  66 default key name used by System.Configuration section encryption/decryption code)
  67
  68 .TP
  69 .B   -s, --size=VALUE
  70 Key size. Specifies the key length for the create operation (see the \fI-c\fR option). Defaults to 1024.
  71
  72 .TP
  73 .B   -p, --path=VALUE
  74 Application physical path. Used when encrypting/decrypting configuration file sections to specify the directory in which
  75 the configuration file lives (see the \fI-cf\fR option). Defaults to current directory.
  76
  77 .TP
  78 .B   -d, --dec, --decrypt=VALUE
  79 Decrypt configuration section. Configuration section must follow the format used when calling ConfigurationManager.GetSection,
  80 i.e.: path/to/section. Only sections known to the configuration system will be processed.
  81
  82 .TP
  83 .B   -e, --enc, --encrypt=VALUE
  84 Encrypt configuration section. Configuration section must follow the format used when calling ConfigurationManager.GetSection,
  85 i.e.: path/to/section. Only sections known to the configuration system will be processed.
  86
  87 .SH AUTHOR
  88 Marek Habersack
  89 .SH COPYRIGHT
  90 Copyright (C) 2010 Novell, Inc (http://novell.com)
  91 .SH MAILING LISTS
  92 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
  93 .SH WEB SITE
  94 Visit: http://mono-project.com for details