Class: Acme::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/acme/client.rb,
lib/acme/client.rb,
lib/acme/client/version.rb,
lib/acme/client/chain_identifier.rb

Defined Under Namespace

Modules: HTTPClient, JWK, Resources, Util Classes: CertificateRequest, ChainIdentifier, Error, SelfSignCertificate

Constant Summary collapse

DEFAULT_DIRECTORY = 
'http://127.0.0.1:4000/directory'.freeze
USER_AGENT = 
"Acme::Client v#{Acme::Client::VERSION} (#{repo_url})".freeze
CONTENT_TYPES = 
{
  pem: 'application/pem-certificate-chain'
}
VERSION = 
'2.0.29'.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(jwk: nil, kid: nil, private_key: nil, directory: DEFAULT_DIRECTORY, connection_options: {}, bad_nonce_retry: 0) ⇒ Client 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/acme/client.rb', line 35

def initialize(jwk: nil, kid: nil, private_key: nil, directory: DEFAULT_DIRECTORY, connection_options: {}, bad_nonce_retry: 0)
  if jwk.nil? && private_key.nil?
    raise ArgumentError, 'must specify jwk or private_key'
  end

  @jwk = if jwk
    jwk
  else
    Acme::Client::JWK.from_private_key(private_key)
  end

  @kid, @connection_options = kid, connection_options
  @bad_nonce_retry = bad_nonce_retry
  @directory_url = URI(directory)
  @nonces ||= []
end

Instance Attribute Details

#jwk ⇒ Object (readonly)

Returns the value of attribute jwk.



52
53
54
 
# File 'lib/acme/client.rb', line 52

def jwk
  @jwk
end

#nonces ⇒ Object (readonly)

Returns the value of attribute nonces.



52
53
54
 
# File 'lib/acme/client.rb', line 52

def nonces
  @nonces
end

Instance Method Details

#account ⇒ Object 



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/acme/client.rb', line 124

def 
  @kid ||= begin
    response = post(endpoint_for(:new_account), payload: { onlyReturnExisting: true }, mode: :jwk)
    response.headers.fetch(:location)
  end

  response = post_as_get(@kid)
  arguments = (response)
  Acme::Client::Resources::.new(self, url: @kid, **arguments)
end

#account_deactivate ⇒ Object 



96
97
98
99
100
 
# File 'lib/acme/client.rb', line 96

def 
  response = post(kid, payload: { status: 'deactivated' })
  arguments = (response)
  Acme::Client::Resources::.new(self, url: kid, **arguments)
end

#account_key_change(new_private_key: nil, new_jwk: nil) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/acme/client.rb', line 102

def (new_private_key: nil, new_jwk: nil)
  if new_private_key.nil? && new_jwk.nil?
    raise ArgumentError, 'must specify new_jwk or new_private_key'
  end
  old_jwk = jwk
  new_jwk ||= Acme::Client::JWK.from_private_key(new_private_key)

  inner_payload_header = {
    url: endpoint_for(:key_change)
  }
  inner_payload = {
    account: kid,
    oldKey: old_jwk.to_h
  }
  payload = JSON.parse(new_jwk.jws(header: inner_payload_header, payload: inner_payload))

  response = post(endpoint_for(:key_change), payload: payload, mode: :kid)
  arguments = (response)
  @jwk = new_jwk
  Acme::Client::Resources::.new(self, url: kid, **arguments)
end

#account_update(contact: nil, terms_of_service_agreed: nil) ⇒ Object 



86
87
88
89
90
91
92
93
94
 
# File 'lib/acme/client.rb', line 86

def (contact: nil, terms_of_service_agreed: nil)
  payload = {}
  payload[:contact] = Array(contact) if contact
  payload[:termsOfServiceAgreed] = terms_of_service_agreed if terms_of_service_agreed

  response = post(kid, payload: payload)
  arguments = (response)
  Acme::Client::Resources::.new(self, url: kid, **arguments)
end

#authorization(url:) ⇒ Object 



189
190
191
192
193
 
# File 'lib/acme/client.rb', line 189

def authorization(url:)
  response = post_as_get(url)
  arguments = attributes_from_authorization_response(response)
  Acme::Client::Resources::Authorization.new(self, url: url, **arguments)
end

#caa_identities ⇒ Object 



260
261
262
 
# File 'lib/acme/client.rb', line 260

def caa_identities
  directory.caa_identities
end

#certificate(url:, force_chain: nil) ⇒ Object

Raises:



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/acme/client.rb', line 169

def certificate(url:, force_chain: nil)
  response = download(url, format: :pem)
  pem = response.body

  return pem if force_chain.nil?

  return pem if ChainIdentifier.new(pem).match_name?(force_chain)

  alternative_urls = Array(response.headers.dig('link', 'alternate'))
  alternative_urls.each do |alternate_url|
    response = download(alternate_url, format: :pem)
    pem = response.body
    if ChainIdentifier.new(pem).match_name?(force_chain)
      return pem
    end
  end

  raise Acme::Client::Error::ForcedChainNotFound, "Could not find any matching chain for `#{force_chain}`"
end

#challenge(url:) ⇒ Object 



201
202
203
204
205
 
# File 'lib/acme/client.rb', line 201

def challenge(url:)
  response = post_as_get(url)
  arguments = attributes_from_challenge_response(response)
  Acme::Client::Resources::Challenges.new(self, **arguments)
end

#deactivate_authorization(url:) ⇒ Object 



195
196
197
198
199
 
# File 'lib/acme/client.rb', line 195

def deactivate_authorization(url:)
  response = post(url, payload: { status: 'deactivated' })
  arguments = attributes_from_authorization_response(response)
  Acme::Client::Resources::Authorization.new(self, url: url, **arguments)
end

#directory ⇒ Object 



244
245
246
 
# File 'lib/acme/client.rb', line 244

def directory
  @directory ||= load_directory
end

#external_account_required ⇒ Object 



264
265
266
 
# File 'lib/acme/client.rb', line 264

def 
  directory.
end

#finalize(url:, csr:) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/acme/client.rb', line 158

def finalize(url:, csr:)
  unless csr.respond_to?(:to_der)
    raise ArgumentError, 'csr must respond to `#to_der`'
  end

  base64_der_csr = Acme::Client::Util.urlsafe_base64(csr.to_der)
  response = post(url, payload: { csr: base64_der_csr })
  arguments = attributes_from_order_response(response)
  Acme::Client::Resources::Order.new(self, **arguments)
end

#get_nonce ⇒ Object 



237
238
239
240
241
242
 
# File 'lib/acme/client.rb', line 237

def get_nonce
  http_client = Acme::Client::HTTPClient.new_connection(url: endpoint_for(:new_nonce), options: @connection_options)
  response = http_client.head(nil, nil)
  nonces << response.headers['replay-nonce']
  true
end

#kid ⇒ Object 



135
136
137
 
# File 'lib/acme/client.rb', line 135

def kid
  @kid ||= .kid
end

#meta ⇒ Object 



248
249
250
 
# File 'lib/acme/client.rb', line 248

def meta
  directory.meta
end

#new_account(contact:, terms_of_service_agreed: nil, external_account_binding: nil) ⇒ Object 



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
 
# File 'lib/acme/client.rb', line 54

def (contact:, terms_of_service_agreed: nil, external_account_binding: nil)
   = endpoint_for(:new_account)
  payload = {
    contact: Array(contact)
  }

  if terms_of_service_agreed
    payload[:termsOfServiceAgreed] = terms_of_service_agreed
  end

  if 
    kid, hmac_key = .values_at(:kid, :hmac_key)
    if kid.nil? || hmac_key.nil?
      raise ArgumentError, 'must specify kid and hmac_key key for external_account_binding'
    end

    hmac = Acme::Client::JWK::HMAC.new(Base64.urlsafe_decode64(hmac_key))
     = hmac.jws(header: { kid: kid, url:  }, payload: @jwk)
    payload[:externalAccountBinding] = JSON.parse()
  end

  response = post(, payload: payload, mode: :jws)
  @kid = response.headers.fetch(:location)

  if response.body.nil? || response.body.empty?
    
  else
    arguments = (response)
    Acme::Client::Resources::.new(self, url: @kid, **arguments)
  end
end

#new_order(identifiers:, not_before: nil, not_after: nil, profile: nil, replaces: nil) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/acme/client.rb', line 139

def new_order(identifiers:, not_before: nil, not_after: nil, profile: nil, replaces: nil)
  payload = {}
  payload['identifiers'] = prepare_order_identifiers(identifiers)
  payload['notBefore'] = not_before if not_before
  payload['notAfter'] = not_after if not_after
  payload['profile'] = profile if profile
  payload['replaces'] = replaces if replaces

  response = post(endpoint_for(:new_order), payload: payload)
  arguments = attributes_from_order_response(response)
  Acme::Client::Resources::Order.new(self, **arguments)
end

#order(url:) ⇒ Object 



152
153
154
155
156
 
# File 'lib/acme/client.rb', line 152

def order(url:)
  response = post_as_get(url)
  arguments = attributes_from_order_response(response)
  Acme::Client::Resources::Order.new(self, **arguments.merge(url: url))
end

#profiles ⇒ Object 



268
269
270
 
# File 'lib/acme/client.rb', line 268

def profiles
  directory.profiles
end

#renewal_info(certificate:) ⇒ Object 



228
229
230
231
232
233
234
235
 
# File 'lib/acme/client.rb', line 228

def renewal_info(certificate:)
  cert_id = Acme::Client::Util.ari_certificate_identifier(certificate)
  renewal_info_url = URI.join(endpoint_for(:renewal_info).to_s + '/', cert_id).to_s

  response = get(renewal_info_url)
  attributes = attributes_from_renewal_info_response(response)
  Acme::Client::Resources::RenewalInfo.new(self, **attributes)
end

#request_challenge_validation(url:, key_authorization: nil) ⇒ Object 



207
208
209
210
211
 
# File 'lib/acme/client.rb', line 207

def request_challenge_validation(url:, key_authorization: nil)
  response = post(url, payload: {})
  arguments = attributes_from_challenge_response(response)
  Acme::Client::Resources::Challenges.new(self, **arguments)
end

#revoke(certificate:, reason: nil) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/acme/client.rb', line 213

def revoke(certificate:, reason: nil)
  der_certificate = if certificate.respond_to?(:to_der)
    certificate.to_der
  else
    OpenSSL::X509::Certificate.new(certificate).to_der
  end

  base64_der_certificate = Acme::Client::Util.urlsafe_base64(der_certificate)
  payload = { certificate: base64_der_certificate }
  payload[:reason] = reason unless reason.nil?

  response = post(endpoint_for(:revoke_certificate), payload: payload)
  response.success?
end

#terms_of_service ⇒ Object 



252
253
254
 
# File 'lib/acme/client.rb', line 252

def terms_of_service
  directory.terms_of_service
end

#website ⇒ Object 



256
257
258
 
# File 'lib/acme/client.rb', line 256

def website
  directory.website
end