GlobalSign

A Ruby interface to the GlobalSign API.

For more information and detailed documentation about the API visit this page .

Installation

Add this line to your application's Gemfile:

gem 'global_sign'

And then execute:

$ bundle

Or install it yourself as:

$ gem install global_sign

Usage

Configuration

An example initializer would look something like this:

GlobalSign.configure do |configuration|
  configuration.user_name = 'PAR12345_taro'
  configuration.password  = 'password'
  configuration.endpoint  = 'https://test-gcc.globalsign.com/kb/ws/v1'
end

URL Verification

require 'global_sign'

client = GlobalSign::Client.new

# Prepare CSR beforehand
csr = <<-EOS
-----BEGIN CERTIFICATE REQUEST-----
...
-----END CERTIFICATE REQUEST-----
EOS

contract = GlobalSign::Contract.new(
  first_name:   'Pepabo',
  last_name:    'Taro',
  phone_number: '090-1234-5678',
  email:        '[email protected]',
)

request = GlobalSign::UrlVerification::Request.new(
  product_code:           'DV_LOW_URL',   # 'DV_HIGH_URL' or 'DV_LOW_URL'
  order_kind:             'new',   # If you request a new certificate
  validity_period_months: 6,
  csr:                    csr,
  contract_info:          contract,
)

response = client.process(request)

if response.success?
  puts "Successfully URL Verification"
  puts response.params # => { meta_tag: "xxxxx", ... }
else
  raise StandardError, "#{response.error_code}: #{response.error_message}"
end

It's also possible to set contract within your configure block.

GlobalSign.set_contract do |contract|
  contract.first_name   = 'Pepabo'
  contract.last_name    = 'Taro'
  contract.phone_number = '090-1234-5678'
  contract.email        = '[email protected]'
end

# Not need to give the argument 'contract_info'
request = GlobalSign::UrlVerification::Request.new(
  product_code:           'DV_LOW_URL',
  order_kind:             'new',
  validity_period_months: 6,
  csr:                    csr,
)

If you request a renewal certificate, you should set renewal to the value of argument order_kind.
And you should give the argument renewal_target_order_id .

request = GlobalSign::UrlVerification::Request.new(
  product_code:            'DV_LOW_URL',
  order_kind:              'renewal',
  validity_period_months:  6,
  csr:                     csr,
  renewal_target_order_id: 'xxxx123456789',
  contract_info:           contract,
)

DNS Verification

Verification flow is the same as URL Verification. Request class use the following:

client = GlobalSign::Client.new

request = GlobalSign::DnsVerification::Request.new(
  product_code:           'DV_LOW_DNS',
  order_kind:             'new',
  validity_period_months: 6,
  csr:                    csr,
  contract_info:          contract,
)

response = client.process(request)

if response.success?
  puts "Successfully DNS Verification"
  puts response.params # => { dns_txt: "xxxxx", verification_fqdn_list: ['example.com', 'www.example.com'], ... }
else
  raise StandardError, "#{response.error_code}: #{response.error_message}"
end

URL Verification for Issue

client = GlobalSign::Client.new

# You can use ApproverURL value such as:
# - http://example.com
# - https://example.com
# - http://www.example.com
# - https://www.example.com

request = GlobalSign::UrlVerificationForIssue::Request.new(
  order_id:     'xxxx123456789',
  approver_url: 'http://example.com',
)

response = client.process(request)

if response.success?
  puts "Successfully URL Verification for Issue"
  puts response.params # => { fulfillment: { ca_certificates: [{ ca_cert: "xxxxx" }, ...]}, ... }
else
  raise StandardError, "#{response.error_code}: #{response.error_message}"
end

DNS Verification for Issue

client = GlobalSign::Client.new

# You can use ApproverFQDN value such as:
# - www.example.com
# - example.com

request = GlobalSign::UrlVerificationForIssue::Request.new(
  order_id:      'xxxx123456789',
  approver_fqdn: 'www.example.com',
)

response = client.process(request)

if response.success?
  puts "Successfully DNS Verification for Issue"
  puts response.params # => { fulfillment: { ca_certificates: [{ ca_cert: "xxxxx" }, ...]}, ... }
else
  raise StandardError, "#{response.error_code}: #{response.error_message}"
end

Get Order by OrderID

request = GlobalSign::OrderGetterByOrderId::Request.new(
  order_id: 'xxxx123456789'
)
response = client.process(request)

puts response.params # => { order_id: "xxxx123456789", order_status: "2", ... }

# You can get order_status explanation
puts response.order_status_text  # => "phishing_checking"

You can specify request options.

# certificate_info option
request = GlobalSign::OrderGetterByOrderId::Request.new(
  order_id: 'xxxx123456789',
  options:  { certificate_info: true }
)
response = client.process(request)

puts response.params[:certificate_info] # => { certificate_status: '4', start_date: '2016-10-06T14:53:23.000+09:00', ... }

# fulfillment option
request = GlobalSign::OrderGetterByOrderId::Request.new(
  order_id: 'xxxx123456789',
  options:  { fulfillment: true }
)
response = client.process(request)

puts response.params[:fulfillment] # => { ca_certificates: [{ ca_cert: "xxxxx" }, ...]}

Decode CSR

request = GlobalSign::CsrDecoder::Request.new(
  product_type: 'DV_LOW',
  csr:          csr
)
response = client.process(request)

puts response.params # => { common_name: "www.example.com", ... }

Client options

GlobalSign::Client allows options argument in order to specify its behavior.
For now, it supports timeout which specifies number of seconds to wait for request.

client = GlobalSign::Client.new(options: { timeout: 120 })

Contributing

1. Create your feature branch (git checkout -b my-new-feature)
2. Commit your changes (git commit -am 'Add some feature')
3. Push to the branch (git push origin my-new-feature)
4. Create a new Pull Request

License

The MIT License (MIT)

Copyright (c) 2016- GMO Pepabo, Inc.