Class: Chef::Provider::AwsKeyPair

Inherits:
Chef::Provisioning::AWSDriver::AWSProvider show all
Defined in:
lib/chef/provider/aws_key_pair.rb

Constant Summary collapse

@@use_pkcs8 =

For Ruby 1.9 and below, PKCS can be run

nil

Constants inherited from Chef::Provisioning::AWSDriver::AWSProvider

Chef::Provisioning::AWSDriver::AWSProvider::AWSResource

Instance Attribute Summary

Attributes inherited from Chef::Provisioning::AWSDriver::AWSProvider

#purging

Instance Method Summary collapse

Methods inherited from Chef::Provisioning::AWSDriver::AWSProvider

#action_handler, #converge_by, #region, #whyrun_supported?

Instance Method Details

#compare_public_key(new) ⇒ Object 



139
140
141
142
143
 
# File 'lib/chef/provider/aws_key_pair.rb', line 139

def compare_public_key(new)
  c = @current_fingerprint.split[0, 2].join(" ")
  n = new.split[0, 2].join(" ")
  c == n
end

#create_key(action) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
 
# File 'lib/chef/provider/aws_key_pair.rb', line 26

def create_key(action)
  if @should_create_directory
    Cheffish.inline_resource(self, action) do
      directory run_context.config[:private_key_write_path]
    end
  end

  if current_resource_exists?
    # If the public keys are different, update the server public key
    if !current_resource.private_key_path
      if new_resource.allow_overwrite
        ensure_keys(action)
      else
        raise "#{key_description} already exists on the server, but the private key #{new_private_key_path} does not exist!"
      end
    else
      ensure_keys(action)
    end

    # “The nice thing about standards is that you have so many to
    # choose from.” - Andrew S. Tanenbaum
    #
    # The AWS EC2 API uses a PKCS#1 MD5 fingerprint for keys that you
    # import into EC2, but a PKCS#8 SHA1 fingerprint for keys that you
    # generate using its web console. Both fingerprints are different
    # from the familiar RFC4716 MD5 fingerprint that OpenSSH displays
    # for host keys.
    #
    # So compute both possible AWS fingerprints and check if either of
    # them matches.
    new_fingerprints = [Cheffish::KeyFormatter.encode(desired_key, format: :fingerprint)]
    if RUBY_VERSION.to_f < 2.0
      if @@use_pkcs8.nil?
        begin
          require "openssl_pkcs8"
          @@use_pkcs8 = true
        rescue LoadError
          Chef::Log.warn("The openssl_pkcs8 gem is not loaded: you may not be able to read key fingerprints created by some cloud providers.  gem install openssl_pkcs8 to fix!")
          @@use_pkcs8 = false
        end
      end
      if @@use_pkcs8
        new_fingerprints << Cheffish::KeyFormatter.encode(desired_private_key,
                                                          format: :pkcs8sha1fingerprint)
      end
    end

    if new_fingerprints.none? { |f| compare_public_key f }
      if new_resource.allow_overwrite
        converge_by "update #{key_description} to match local key at #{new_resource.private_key_path}" do
          driver.ec2.delete_key_pair(key_name: new_resource.name)
          driver.ec2.import_key_pair(key_name: new_resource.name, public_key_material: Cheffish::KeyFormatter.encode(desired_key, format: :openssh))
        end
      else
        raise "#{key_description} with fingerprint #{@current_fingerprint} does not match local key fingerprint(s) #{new_fingerprints}, and allow_overwrite is false!"
      end
    end
  else
    # Generate the private and/or public keys if they do not exist
    ensure_keys(action)

    # Create key
    converge_by "create #{key_description} from local key at #{new_resource.private_key_path}" do
      driver.ec2.import_key_pair(key_name: new_resource.name, public_key_material: Cheffish::KeyFormatter.encode(desired_key, format: :openssh))
    end
  end
end

#current_public_key ⇒ Object 



145
146
147
 
# File 'lib/chef/provider/aws_key_pair.rb', line 145

def current_public_key
  current_resource.source_key
end

#current_resource_exists? ⇒ Boolean

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/chef/provider/aws_key_pair.rb', line 135

def current_resource_exists?
  @current_resource.action != [:destroy]
end

#desired_key ⇒ Object 



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/chef/provider/aws_key_pair.rb', line 113

def desired_key
  @desired_key ||= begin
    if new_resource.public_key_path
      public_key, format = Cheffish::KeyFormatter.decode(IO.read(new_resource.public_key_path))
      public_key
    else
      desired_private_key.public_key
    end
  end
end

#desired_private_key ⇒ Object 



124
125
126
127
128
129
 
# File 'lib/chef/provider/aws_key_pair.rb', line 124

def desired_private_key
  @desired_private_key ||= begin
    private_key, format = Cheffish::KeyFormatter.decode(IO.read(new_private_key_path))
    private_key
  end
end

#driver ⇒ Object 



94
95
96
 
# File 'lib/chef/provider/aws_key_pair.rb', line 94

def driver
  run_context.chef_provisioning.driver_for(new_resource.driver)
end

#ensure_keys(action) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/chef/provider/aws_key_pair.rb', line 98

def ensure_keys(action)
  resource = new_resource
  private_key_path = new_private_key_path
  Cheffish.inline_resource(self, action) do
    private_key private_key_path do
      public_key_path resource.public_key_path
      if resource.private_key_options
        resource.private_key_options.each_pair do |key, value|
          send(key, value)
        end
      end
    end
  end
end

#existing_keypair ⇒ Object 



131
132
133
 
# File 'lib/chef/provider/aws_key_pair.rb', line 131

def existing_keypair
  @existing_keypair ||= new_resource.aws_object
end

#key_description ⇒ Object 



20
21
22
 
# File 'lib/chef/provider/aws_key_pair.rb', line 20

def key_description
  "#{new_resource.name} on #{driver.driver_url}"
end

#load_current_resource ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/chef/provider/aws_key_pair.rb', line 165

def load_current_resource
  @current_resource = Chef::Resource::AwsKeyPair.new(new_resource.name, run_context)

  current_key_pair = new_resource.aws_object
  if current_key_pair
    @current_fingerprint = current_key_pair.key_fingerprint
  else
    current_resource.action [:destroy]
  end

  if new_private_key_path && ::File.exist?(new_private_key_path)
    current_resource.private_key_path new_private_key_path
  end
  if new_public_key_path && ::File.exist?(new_public_key_path)
    current_resource.public_key_path new_public_key_path
  end
end

#new_private_key_path ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/chef/provider/aws_key_pair.rb', line 149

def new_private_key_path
  private_key_path = new_resource.private_key_path || new_resource.name
  if private_key_path.is_a?(Symbol)
    private_key_path
  elsif Pathname.new(private_key_path).relative? && driver.config[:private_key_write_path]
    @should_create_directory = true
    ::File.join(driver.config[:private_key_write_path], private_key_path)
  else
    private_key_path
  end
end

#new_public_key_path ⇒ Object 



161
162
163
 
# File 'lib/chef/provider/aws_key_pair.rb', line 161

def new_public_key_path
  new_resource.public_key_path
end