summaryrefslogtreecommitdiff
path: root/lib/chef/resource/openssl_x509_request.rb
blob: b33a95dfaf313bb4f0954231c1d698603f30ecd6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
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
#
# License:: Apache License, Version 2.0
# Author:: Julien Huon
# Copyright:: Copyright 2018, Chef Software Inc.
#
# Licensed 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.
#

require_relative "../resource"

class Chef
  class Resource
    class OpensslX509Request < Chef::Resource
      require_relative "../mixin/openssl_helper"
      include Chef::Mixin::OpenSSLHelper

      resource_name :openssl_x509_request

      description "Use the openssl_x509_request resource to generate PEM-formatted x509 certificates requests. If no existing key is specified, the resource will automatically generate a passwordless key with the certificate."
      introduced "14.4"

      property :path, String, name_property: true,
               description: "An optional property for specifying the path to write the file to if it differs from the resource block's name."

      property :owner, [String, Integer],
               description: "The owner applied to all files created by the resource."

      property :group, [String, Integer],
               description: "The group ownership applied to all files created by the resource."

      property :mode, [Integer, String],
               description: "The permission mode applied to all files created by the resource."

      property :country, String,
               description: "Value for the C certificate field."

      property :state, String,
               description: "Value for the ST certificate field."

      property :city, String,
               description: "Value for the L certificate field."

      property :org, String,
               description: "Value for the O certificate field."

      property :org_unit, String,
               description: "Value for the OU certificate field."

      property :common_name, String,
               required: true,
               description: "Value for the CN certificate field."

      property :email, String,
               description: "Value for the email certificate field."

      property :key_file, String,
               description: "The path to a certificate key file on the filesystem. If the key_file property is specified, the resource will attempt to source a key from this location. If no key file is found, the resource will generate a new key file at this location. If the key_file property is not specified, the resource will generate a key file in the same directory as the generated certificate, with the same name as the generated certificate."

      property :key_pass, String,
               description: "The passphrase for an existing key's passphrase."

      property :key_type, String,
               equal_to: %w{rsa ec}, default: "ec",
               description: "The desired type of the generated key (rsa or ec)."

      property :key_length, Integer,
               equal_to: [1024, 2048, 4096, 8192], default: 2048,
               description: "The desired bit length of the generated key (if key_type is equal to 'rsa')."

      property :key_curve, String,
               equal_to: %w{secp384r1 secp521r1 prime256v1}, default: "prime256v1",
               description: "The desired curve of the generated key (if key_type is equal to 'ec'). Run openssl ecparam -list_curves to see available options."

      default_action :create

      action :create do
        description "Generate a certificate request."

        unless ::File.exist? new_resource.path
          converge_by("Create CSR #{@new_resource}") do
            file new_resource.path do
              owner new_resource.owner unless new_resource.owner.nil?
              group new_resource.group unless new_resource.group.nil?
              mode new_resource.mode unless new_resource.mode.nil?
              content csr.to_pem
              action :create
            end

            file new_resource.key_file do
              owner new_resource.owner unless new_resource.owner.nil?
              group new_resource.group unless new_resource.group.nil?
              mode new_resource.mode unless new_resource.mode.nil?
              content key.to_pem
              sensitive true
              action :create_if_missing
            end
          end
        end
      end

      action_class do
        def generate_key_file
          unless new_resource.key_file
            path, file = ::File.split(new_resource.path)
            filename = ::File.basename(file, ::File.extname(file))
            new_resource.key_file path + "/" + filename + ".key"
          end
          new_resource.key_file
        end

        def key
          @key ||= if priv_key_file_valid?(generate_key_file, new_resource.key_pass)
                     OpenSSL::PKey.read ::File.read(generate_key_file), new_resource.key_pass
                   elsif new_resource.key_type == "rsa"
                     gen_rsa_priv_key(new_resource.key_length)
                   else
                     gen_ec_priv_key(new_resource.key_curve)
                   end
          @key
        end

        def subject
          csr_subject = OpenSSL::X509::Name.new()
          csr_subject.add_entry("C", new_resource.country) unless new_resource.country.nil?
          csr_subject.add_entry("ST", new_resource.state) unless new_resource.state.nil?
          csr_subject.add_entry("L", new_resource.city) unless new_resource.city.nil?
          csr_subject.add_entry("O", new_resource.org) unless new_resource.org.nil?
          csr_subject.add_entry("OU", new_resource.org_unit) unless new_resource.org_unit.nil?
          csr_subject.add_entry("CN", new_resource.common_name)
          csr_subject.add_entry("emailAddress", new_resource.email) unless new_resource.email.nil?
          csr_subject
        end

        def csr
          gen_x509_request(subject, key)
        end
      end
    end
  end
end