acme-client 2.0.22 → 2.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4c163dbc54a7e15b4e33aadbc892e9f9cca5fb4d2332873e9f0a4ca4b46d144
-  data.tar.gz: 7fedb1bf7034c1a52a5f05169782e31b31749ecd6d8beb1a22da60ed44d49731
+  metadata.gz: 57864d566a88b4298a243bfaa6f34b5556a7aa1f36f41fd4e61636d0e7fae74e
+  data.tar.gz: c68a9476baa8fad93f9373e16d3dad6249edb2cc7f007d0d1bf4386cf0cf7f6e
 SHA512:
-  metadata.gz: b1431a5b7890db3433aded0eaa9bccbdd14b60d9d95da840ee8d42e18c4f304e57b78431fa1313a77b06cb7e3e114dcba59471d48b8a1b3e099cc06eb4728df1
-  data.tar.gz: c2e0b53200d61ae3d38ea75b656dc92de9751ad32a6a86a3346cd8ac843fccab097c70dd5e1d6870597510c33b6cdfde866de6e31f919d96fc23c91edc83384c
+  metadata.gz: c2cb942f81bfb49f952f955b9eea415b86718c8fe4fb3426cf7cdc1fcb8925b97dfe20e07300480fef894b6438ab5b2046d670564f8bc66a8a80bd5f14e2a282
+  data.tar.gz: f5343edaa0fb6543d2f37e6017732969e63e687c9db877ff8ba188444244e1a180b59cedfbbef12d021a702f65cb089fc08f0ec79ab2363b660343d9df421f5c

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## `2.0.25`
+
+* Add support for profiles extension
+
+## `2.0.24`
+
+* Add support for account orders url attribute.
+
+## `2.0.23`
+
+* Allow Order to be create without url. Location is not always required in the specification. 
+
 ## `2.0.22`
 
 * Loosen base64 dependency constraint

data/README.md

@@ -244,6 +244,22 @@ new_private_key = OpenSSL::PKey::RSA.new(4096)
 client.account_key_change(new_private_key: new_private_key)
 ```
 
+### Profile Extension
+
+Provide a CA profile when creating a new order:
+
+```ruby
+order = client.new_order(identifiers: ['example.com'], profile: 'shortlived')
+```
+
+ACME servers may list supported profiles in the directory endpoint:
+
+```ruby
+client.profiles => {"classic": "https://example.com/docs/classic", "shortlived": "https://example.com/docs/shortlived"}
+```
+
+See the [RFC draft of certificate profiles](https://datatracker.ietf.org/doc/draft-aaron-acme-profiles/) for more info.
+
 ## Requirements
 
 Ruby >= 3.0

data/lib/acme/client/error.rb

@@ -9,6 +9,7 @@ class Acme::Client::Error < StandardError
   class CertificateNotReady < ClientError; end
   class ForcedChainNotFound < ClientError; end
   class OrderNotReady < ClientError; end
+  class OrderNotReloadable < ClientError; end
 
   class ServerError < Acme::Client::Error; end
   class AlreadyRevoked < ServerError; end

data/lib/acme/client/resources/account.rb

@@ -34,16 +34,18 @@ class Acme::Client::Resources::Account
       url: url,
       term_of_service: term_of_service,
       status: status,
-      contact: contact
+      contact: contact,
+      orders: orders_url
     }
   end
 
   private
 
-  def assign_attributes(url:, term_of_service:, status:, contact:)
+  def assign_attributes(url:, term_of_service:, status:, contact:, orders: nil)
     @url = url
     @term_of_service = term_of_service
     @status = status
     @contact = Array(contact)
+    @orders_url = orders
   end
 end

data/lib/acme/client/resources/directory.rb

@@ -14,7 +14,8 @@ class Acme::Client::Resources::Directory
     terms_of_service: 'termsOfService',
     website: 'website',
     caa_identities: 'caaIdentities',
-    external_account_required: 'externalAccountRequired'
+    external_account_required: 'externalAccountRequired',
+    profiles: 'profiles'
   }
 
   def initialize(client, **arguments)
@@ -45,6 +46,10 @@ class Acme::Client::Resources::Directory
     meta[DIRECTORY_META[:external_account_required]]
   end
 
+  def profiles
+    meta[DIRECTORY_META[:profiles]]
+  end
+
   def meta
     @directory[:meta]
   end

data/lib/acme/client/resources/order.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Acme::Client::Resources::Order
-  attr_reader :url, :status, :contact, :finalize_url, :identifiers, :authorization_urls, :expires, :certificate_url
+  attr_reader :url, :status, :contact, :finalize_url, :identifiers, :authorization_urls, :expires, :certificate_url, :profile
 
   def initialize(client, **arguments)
     @client = client
@@ -9,6 +9,10 @@ class Acme::Client::Resources::Order
   end
 
   def reload
+    if url.nil?
+      raise Acme::Client::Error::OrderNotReloadable, 'Finalized orders are not reloadable for this CA'
+    end
+
     assign_attributes(**@client.order(url: url).to_h)
     true
   end
@@ -40,13 +44,14 @@ class Acme::Client::Resources::Order
       finalize_url: finalize_url,
       authorization_urls: authorization_urls,
       identifiers: identifiers,
-      certificate_url: certificate_url
+      certificate_url: certificate_url,
+      profile: profile
     }
   end
 
   private
 
-  def assign_attributes(url:, status:, expires:, finalize_url:, authorization_urls:, identifiers:, certificate_url: nil)
+  def assign_attributes(url: nil, status:, expires:, finalize_url:, authorization_urls:, identifiers:, certificate_url: nil, profile: nil) # rubocop:disable Layout/LineLength,Metrics/ParameterLists
     @url = url
     @status = status
     @expires = expires
@@ -54,5 +59,6 @@ class Acme::Client::Resources::Order
     @authorization_urls = authorization_urls
     @identifiers = identifiers
     @certificate_url = certificate_url
+    @profile = profile
   end
 end

data/lib/acme/client/version.rb

@@ -2,6 +2,6 @@
 
 module Acme
   class Client
-    VERSION = '2.0.22'.freeze
+    VERSION = '2.0.25'.freeze
   end
 end

data/lib/acme/client.rb

@@ -135,11 +135,12 @@ class Acme::Client
     @kid ||= account.kid
   end
 
-  def new_order(identifiers:, not_before: nil, not_after: nil)
+  def new_order(identifiers:, not_before: nil, not_after: nil, profile: 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
 
     response = post(endpoint_for(:new_order), payload: payload)
     arguments = attributes_from_order_response(response)
@@ -253,6 +254,10 @@ class Acme::Client
     directory.external_account_required
   end
 
+  def profiles
+    directory.profiles
+  end
+
   private
 
   def load_directory
@@ -286,6 +291,7 @@ class Acme::Client
       response.body,
       :status,
       [:term_of_service, 'termsOfServiceAgreed'],
+      :orders,
       :contact
     )
   end
@@ -298,7 +304,8 @@ class Acme::Client
       [:finalize_url, 'finalize'],
       [:authorization_urls, 'authorizations'],
       [:certificate_url, 'certificate'],
-      :identifiers
+      :identifiers,
+      :profile
     )
 
     attributes[:url] = response.headers[:location] if response.headers[:location]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: acme-client
 version: !ruby/object:Gem::Version
-  version: 2.0.22
+  version: 2.0.25
 platform: ruby
 authors:
 - Charles Barbier
 bindir: bin
 cert_chain: []
-date: 2025-07-01 00:00:00.000000000 Z
+date: 2025-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake