diff --git a/lib/puppet/application/cert.rb b/lib/puppet/application/cert.rb index 0db968e9e..0808a42da 100644 --- a/lib/puppet/application/cert.rb +++ b/lib/puppet/application/cert.rb @@ -1,196 +1,207 @@ require 'puppet/application' class Puppet::Application::Cert < Puppet::Application should_parse_config run_mode :master attr_accessor :cert_mode, :all, :ca, :digest, :signed def find_mode(opt) require 'puppet/ssl/certificate_authority' modes = Puppet::SSL::CertificateAuthority::Interface::INTERFACE_METHODS tmp = opt.sub("--", '').to_sym @cert_mode = modes.include?(tmp) ? tmp : nil end option("--clean", "-c") do @cert_mode = :destroy end option("--all", "-a") do @all = true end option("--digest DIGEST") do |arg| @digest = arg end option("--signed", "-s") do @signed = true end option("--debug", "-d") do |arg| Puppet::Util::Log.level = :debug end require 'puppet/ssl/certificate_authority/interface' Puppet::SSL::CertificateAuthority::Interface::INTERFACE_METHODS.reject {|m| m == :destroy }.each do |method| option("--#{method}", "-#{method.to_s[0,1]}") do find_mode("--#{method}") end end option("--verbose", "-v") do Puppet::Util::Log.level = :info end def help <<-HELP -SYNOPSIS +puppet-cert(8) -- Manage certificates and requests ======== -Stand-alone certificate authority. Capable of generating certificates -but mostly meant for signing certificate requests from puppet clients. + +SYNOPSIS +-------- +Standalone certificate authority. Capable of generating certificates, +but mostly used for signing certificate requests from puppet clients. USAGE -===== - puppet cert [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] - [-g|--generate] [-l|--list] [-s|--sign] [-r|--revoke] - [-p|--print] [-c|--clean] [--verify] [--digest DIGEST] - [--fingerprint] [host] +----- +puppet cert [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose] + [-g|--generate] [-l|--list] [-s|--sign] [-r|--revoke] [-p|--print] + [-c|--clean] [--verify] [--digest ] [--fingerprint] [host] DESCRIPTION -=========== -Because the puppetmasterd daemon defaults to not signing client +----------- +Because the puppet master service defaults to not signing client certificate requests, this script is available for signing outstanding requests. It can be used to list outstanding requests and then either sign them individually or sign all of them. OPTIONS -======= +------- Note that any configuration parameter that's valid in the configuration file is also a valid long argument. For example, 'ssldir' is a valid configuration parameter, so you can specify '--ssldir ' as an argument. See the configuration file documentation at http://docs.puppetlabs.com/references/stable/configuration.html for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet cert with '--genconfig'. -all: Operate on all items. Currently only makes sense with - '--sign', '--clean', or '--list'. +* --all: + Operate on all items. Currently only makes sense with '--sign', + '--clean', or '--list'. -digest: Set the digest for fingerprinting (defaults to md5). Valid - values depends on your openssl and openssl ruby extension - version, but should contain at least md5, sha1, md2, - sha256. +* --digest: + Set the digest for fingerprinting (defaults to md5). Valid values + depends on your openssl and openssl ruby extension version, but should + contain at least md5, sha1, md2, sha256. -clean: Remove all files related to a host from puppet cert's - storage. This is useful when rebuilding hosts, since new - certificate signing requests will only be honored if puppet - cert does not have a copy of a signed certificate for that - host. The certificate of the host is also revoked. If - '--all' is specified then all host certificates, both - signed and unsigned, will be removed. +* --clean: + Remove all files related to a host from puppet cert's storage. This is + useful when rebuilding hosts, since new certificate signing requests + will only be honored if puppet cert does not have a copy of a signed + certificate for that host. The certificate of the host is also + revoked. If '--all' is specified then all host certificates, both + signed and unsigned, will be removed. -debug: Enable full debugging. +* --debug: + Enable full debugging. -generate: Generate a certificate for a named client. A - certificate/keypair will be generated for each client named - on the command line. +* --generate: + Generate a certificate for a named client. A certificate/keypair will + be generated for each client named on the command line. -help: Print this help message +* --help: + Print this help message -list: List outstanding certificate requests. If '--all' is - specified, signed certificates are also listed, prefixed by - '+', and revoked or invalid certificates are prefixed by - '-' (the verification outcome is printed in parenthesis). +* --list: + List outstanding certificate requests. If '--all' is specified, signed + certificates are also listed, prefixed by '+', and revoked or invalid + certificates are prefixed by '-' (the verification outcome is printed + in parenthesis). -print: Print the full-text version of a host's certificate. +* --print: + Print the full-text version of a host's certificate. -fingerprint: Print the DIGEST (defaults to md5) fingerprint of a host's - certificate. +* --fingerprint: + Print the DIGEST (defaults to md5) fingerprint of a host's + certificate. -revoke: Revoke the certificate of a client. The certificate can be - specified either by its serial number, given as a decimal - number or a hexadecimal number prefixed by '0x', or by its - hostname. The certificate is revoked by adding it to the - Certificate Revocation List given by the 'cacrl' config - parameter. Note that the puppetmasterd needs to be - restarted after revoking certificates. +* --revoke: + Revoke the certificate of a client. The certificate can be specified + either by its serial number, given as a decimal number or a + hexadecimal number prefixed by '0x', or by its hostname. The + certificate is revoked by adding it to the Certificate Revocation List + given by the 'cacrl' config parameter. Note that the puppetmasterd + needs to be restarted after revoking certificates. -sign: Sign an outstanding certificate request. Unless '--all' is - specified, hosts must be listed after all flags. +* --sign: + Sign an outstanding certificate request. Unless '--all' is specified, + hosts must be listed after all flags. -verbose: Enable verbosity. +* --verbose: + Enable verbosity. -version: Print the puppet version number and exit. +* --version: + Print the puppet version number and exit. -verify: Verify the named certificate against the local CA - certificate. +* --verify: + Verify the named certificate against the local CA certificate. EXAMPLE -======= - $ puppet cert -l - culain.madstop.com - $ puppet cert -s culain.madstop.com +------- + $ puppet cert -l + culain.madstop.com + $ puppet cert -s culain.madstop.com AUTHOR -====== +------ Luke Kanies COPYRIGHT -========= +--------- Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License HELP end def main if @all hosts = :all elsif @signed hosts = :signed else hosts = command_line.args.collect { |h| h.downcase } end begin @ca.apply(:revoke, :to => hosts) if @cert_mode == :destroy @ca.apply(@cert_mode, :to => hosts, :digest => @digest) rescue => detail puts detail.backtrace if Puppet[:trace] puts detail.to_s exit(24) end end def setup exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs? Puppet::Util::Log.newdestination :console if [:generate, :destroy].include? @cert_mode Puppet::SSL::Host.ca_location = :local else Puppet::SSL::Host.ca_location = :only end begin @ca = Puppet::SSL::CertificateAuthority.new rescue => detail puts detail.backtrace if Puppet[:trace] puts detail.to_s exit(23) end end end diff --git a/lib/puppet/application/describe.rb b/lib/puppet/application/describe.rb index 0c7bea96d..bd2337577 100644 --- a/lib/puppet/application/describe.rb +++ b/lib/puppet/application/describe.rb @@ -1,256 +1,262 @@ require 'puppet/application' class Formatter def initialize(width) @width = width end def wrap(txt, opts) return "" unless txt && !txt.empty? work = (opts[:scrub] ? scrub(txt) : txt) indent = (opts[:indent] ? opts[:indent] : 0) textLen = @width - indent patt = Regexp.new("^(.{0,#{textLen}})[ \n]") prefix = " " * indent res = [] while work.length > textLen if work =~ patt res << $1 work.slice!(0, $MATCH.length) else res << work.slice!(0, textLen) end end res << work if work.length.nonzero? prefix + res.join("\n#{prefix}") end def header(txt, sep = "-") "\n#{txt}\n" + sep * txt.size end private def scrub(text) # For text with no carriage returns, there's nothing to do. return text if text !~ /\n/ indent = nil # If we can match an indentation, then just remove that same level of # indent from every line. if text =~ /^(\s+)/ indent = $1 return text.gsub(/^#{indent}/,'') else return text end end end class TypeDoc def initialize @format = Formatter.new(76) @types = {} Puppet::Type.loadall Puppet::Type.eachtype { |type| next if type.name == :component @types[type.name] = type } end def list_types puts "These are the types known to puppet:\n" @types.keys.sort { |a, b| a.to_s <=> b.to_s }.each do |name| type = @types[name] s = type.doc.gsub(/\s+/, " ") n = s.index(".") if n.nil? s = ".. no documentation .." elsif n > 45 s = s[0, 45] + " ..." else s = s[0, n] end printf "%-15s - %s\n", name, s end end def format_type(name, opts) name = name.to_sym unless @types.has_key?(name) puts "Unknown type #{name}" return end type = @types[name] puts @format.header(name.to_s, "=") puts @format.wrap(type.doc, :indent => 0, :scrub => true) + "\n\n" puts @format.header("Parameters") if opts[:parameters] format_attrs(type, [:property, :param]) else list_attrs(type, [:property, :param]) end if opts[:meta] puts @format.header("Meta Parameters") if opts[:parameters] format_attrs(type, [:meta]) else list_attrs(type, [:meta]) end end if type.providers.size > 0 puts @format.header("Providers") if opts[:providers] format_providers(type) else list_providers(type) end end end # List details about attributes def format_attrs(type, attrs) docs = {} type.allattrs.each do |name| kind = type.attrtype(name) docs[name] = type.attrclass(name).doc if attrs.include?(kind) && name != :provider end docs.sort { |a,b| a[0].to_s <=> b[0].to_s }.each { |name, doc| print "\n- **#{name}**" if type.key_attributes.include?(name) and name != :name puts " (*namevar*)" else puts "" end puts @format.wrap(doc, :indent => 4, :scrub => true) } end # List the names of attributes def list_attrs(type, attrs) params = [] type.allattrs.each do |name| kind = type.attrtype(name) params << name.to_s if attrs.include?(kind) && name != :provider end puts @format.wrap(params.sort.join(", "), :indent => 4) end def format_providers(type) type.providers.sort { |a,b| a.to_s <=> b.to_s }.each { |prov| puts "\n- **#{prov}**" puts @format.wrap(type.provider(prov).doc, :indent => 4, :scrub => true) } end def list_providers(type) list = type.providers.sort { |a,b| a.to_s <=> b.to_s }.join(", ") puts @format.wrap(list, :indent => 4) end end class Puppet::Application::Describe < Puppet::Application banner "puppet describe [options] [type]" should_not_parse_config option("--short", "-s", "Only list parameters without detail") do |arg| options[:parameters] = false end option("--providers","-p") option("--list", "-l") option("--meta","-m") def help <<-HELP -SYNOPSIS +puppet-describe(8) -- Display help about resource types ======== -Print help about puppet types on the console. Run with '-h' to get -detailed help. +SYNOPSIS +-------- +Prints help about Puppet resource types, providers, and metaparameters. USAGE -===== - puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta] +----- +puppet describe [-h|--help] [-s|--short] [-p|--providers] [-l|--list] [-m|--meta] DESCRIPTION -=========== +----------- Prints details of Puppet types, providers and metaparameters on the console. OPTIONS -======= -help: Print this help text +------- +* --help: + Print this help text -providers: Describe providers in detail for each type +* --providers: + Describe providers in detail for each type -list: List all types +* --list: + List all types -meta: List all metaparameters +* --meta: + List all metaparameters -short: List only parameters without detail +* --short: + List only parameters without detail EXAMPLE -======= - puppet describe --list - puppet describe file --providers - puppet describe user -s -m +------- + $ puppet describe --list + $ puppet describe file --providers + $ puppet describe user -s -m AUTHOR -====== +------ David Lutterkort COPYRIGHT -========= +--------- Copyright (c) 2005 Puppet Labs, LLC Licensed under the GNU Public License HELP end def preinit options[:parameters] = true end def main doc = TypeDoc.new if options[:list] doc.list_types else options[:types].each { |name| doc.format_type(name, options) } end end def setup options[:types] = command_line.args.dup handle_help(nil) unless options[:list] || options[:types].size > 0 $stderr.puts "Warning: ignoring types when listing all types" if options[:list] && options[:types].size > 0 end end