Class: Puppet::Application::Cert

Inherits:
Puppet::Application show all
Defined in:
lib/vendor/puppet/application/cert.rb

Constant Summary

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows

Instance Attribute Summary collapse

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], banner, clear!, clear?, #configure_indirector_routes, controlled_run, exit, find, #handlearg, #initialize, interrupted?, #name, option, option_parser_commands, #preinit, restart!, restart_requested?, #run, #run_command, run_mode, #set_run_mode, #setup_logs, should_not_parse_config, should_parse_config, #should_parse_config?, should_parse_config?, stop!, stop_requested?

Methods included from Util

absolute_path?, activerecord_version, benchmark, binread, chuser, classproxy, #execfail, #execpipe, execute, execute_posix, execute_windows, logmethods, memory, path_to_uri, proxy, replace_file, safe_posix_fork, symbolize, symbolizehash, symbolizehash!, synchronize_on, thinmark, #threadlock, uri_to_path, wait_for_output, which, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Attribute Details

#all ⇒ Object

Returns the value of attribute all.



8
9
10
 
# File 'lib/vendor/puppet/application/cert.rb', line 8

def all
  @all
end

#ca ⇒ Object

Returns the value of attribute ca.



8
9
10
 
# File 'lib/vendor/puppet/application/cert.rb', line 8

def ca
  @ca
end

#digest ⇒ Object

Returns the value of attribute digest.



8
9
10
 
# File 'lib/vendor/puppet/application/cert.rb', line 8

def digest
  @digest
end

#signed ⇒ Object

Returns the value of attribute signed.



8
9
10
 
# File 'lib/vendor/puppet/application/cert.rb', line 8

def signed
  @signed
end

Instance Method Details

#help ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/vendor/puppet/application/cert.rb', line 55

def help
  <<-'HELP'

puppet-cert(8) -- Manage certificates and requests
========

SYNOPSIS
--------
Standalone certificate authority. Capable of generating certificates,
but mostly used for signing certificate requests from puppet clients.


USAGE
-----
puppet cert <action> [-h|--help] [-V|--version] [-d|--debug] [-v|--verbose]
[--digest <digest>] [<host>]


DESCRIPTION
-----------
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.

ACTIONS
-------

Every action except 'list' and 'generate' requires a hostname to act on,
unless the '--all' option is set.

* clean:
Revoke a host's certificate (if applicable) and remove all files
related to that 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. If '--all' is specified then all host certificates,
both signed and unsigned, will be removed.

* fingerprint:
Print the DIGEST (defaults to md5) fingerprint of a host's
certificate.

* generate:
Generate a certificate for a named client. A certificate/keypair will
be generated for each client named on the command line.

* 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.

* revoke:
Revoke the certificate of a client. The certificate can be specified either
by its serial number (given as 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' configuration option. Note that the puppet master
needs to be restarted after revoking certificates.

* sign:
Sign an outstanding certificate request.

* verify:
Verify the named certificate against the local CA certificate.


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 <directory>' 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 the 'sign',
'clean', 'list', and 'fingerprint' actions.

* --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.

* --debug:
Enable full debugging.

* --help:
Print this help message

* --verbose:
Enable verbosity.

* --version:
Print the puppet version number and exit.


EXAMPLE
-------
  $ puppet cert list
  culain.madstop.com
  $ puppet cert sign culain.madstop.com


AUTHOR
------
Luke Kanies


COPYRIGHT
---------
Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License

  HELP
end

#main ⇒ Object 



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/vendor/puppet/application/cert.rb', line 179

def main
  if @all
    hosts = :all
  elsif @signed
    hosts = :signed
  else
    hosts = command_line.args.collect { |h| h.downcase }
  end
  begin
    @ca.apply(:revoke, options.merge(:to => hosts)) if subcommand == :destroy
    @ca.apply(subcommand, options.merge(:to => hosts, :digest => @digest))
  rescue => detail
    puts detail.backtrace if Puppet[:trace]
    puts detail.to_s
    exit(24)
  end
end

#parse_options ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/vendor/puppet/application/cert.rb', line 227

def parse_options
  # handle the bareword subcommand pattern.
  result = super
  unless self.subcommand then
    if sub = self.command_line.args.shift then
      self.subcommand = sub
    else
      puts help
      exit
    end
  end
  result
end

#setup ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/vendor/puppet/application/cert.rb', line 197

def setup
  require 'puppet/ssl/certificate_authority'
  exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?

  Puppet::Util::Log.newdestination :console

  if [:generate, :destroy].include? subcommand
    Puppet::SSL::Host.ca_location = :local
  else
    Puppet::SSL::Host.ca_location = :only
  end

  # If we are generating, and the option came from the CLI, it gets added to
  # the data.  This will do the right thing for non-local certificates, in
  # that the command line but *NOT* the config file option will apply.
  if subcommand == :generate
    if Puppet.settings.setting(:dns_alt_names).setbycli
      options[:dns_alt_names] = Puppet[:dns_alt_names]
    end
  end

  begin
    @ca = Puppet::SSL::CertificateAuthority.new
  rescue => detail
    puts detail.backtrace if Puppet[:trace]
    puts detail.to_s
    exit(23)
  end
end

#subcommand ⇒ Object 



10
11
12
 
# File 'lib/vendor/puppet/application/cert.rb', line 10

def subcommand
  @subcommand
end

#subcommand=(name) ⇒ Object 



14
15
16
17
18
 
# File 'lib/vendor/puppet/application/cert.rb', line 14

def subcommand=(name)
  # Handle the nasty, legacy mapping of "clean" to "destroy".
  sub = name.to_sym
  @subcommand = (sub == :clean ? :destroy : sub)
end