summaryrefslogtreecommitdiff
path: root/lib/xml/kit/certificate.rb
blob: 46df7d6898ab50255f90a13c6a7a64b2ffdb398e (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
# frozen_string_literal: true

require 'xml/kit/templatable'

module Xml
  module Kit
    # {include:file:spec/xml/kit/certificate_spec.rb}
    class Certificate
      include Templatable
      # rubocop:disable Metrics/LineLength
      BASE64_FORMAT = %r(\A([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?\Z).freeze
      # rubocop:enable Metrics/LineLength
      BEGIN_CERT = /-----BEGIN CERTIFICATE-----/.freeze
      END_CERT = /-----END CERTIFICATE-----/.freeze
      # The use can be `:signing` or `:encryption`. Use `nil` for both.
      attr_reader :use

      # The raw certificate value. This can be a Base64 encoded PEM or just a PEM format.
      attr_reader :value

      def initialize(value, use: nil)
        @value = value
        @use = use.nil? ? use : use.downcase.to_sym
      end

      # @return [Xml::Kit::Fingerprint] the certificate fingerprint.
      def fingerprint
        Fingerprint.new(value)
      end

      # Returns true if this certificate is for the specified use.
      #
      # @param use [Symbol] `:signing` or `:encryption`.
      # @return [Boolean] true or false.
      def for?(use)
        return true if self.use.nil?

        self.use == use.to_sym
      end

      # Returns true if this certificate is used for encryption.
      #
      # return [Boolean] true or false.
      def encryption?
        for?(:encryption)
      end

      # Returns true if this certificate is used for signing.
      #
      # return [Boolean] true or false.
      def signing?
        for?(:signing)
      end

      # Returns the x509 form.
      #
      # return [OpenSSL::X509::Certificate] the OpenSSL equivalent.
      def x509
        @x509 ||= self.class.to_x509(value)
      end

      # Returns the public key.
      #
      # @return [OpenSSL::PKey::RSA] the RSA public key.
      def public_key
        x509.public_key
      end

      def ==(other)
        fingerprint == other.fingerprint
      end

      def eql?(other)
        self == other
      end

      def hash
        value.hash
      end

      def to_s
        value
      end

      def to_h
        { use: @use, fingerprint: fingerprint.to_s }
      end

      def inspect
        to_h.inspect
      end

      def stripped
        self.class.strip(x509.to_pem)
      end

      def to_key_pair(private_key, passphrase: nil, use: nil)
        KeyPair.new(x509.to_pem, private_key.to_s, passphrase, use)
      end

      def expired?(time = Time.now)
        x509.not_after <= time
      end

      def active?(time = Time.now)
        x509.not_before <= time && !expired?(time)
      end

      def not_after
        x509.not_after
      end

      def not_before
        x509.not_before
      end

      def key_info
        @key_info ||= KeyInfo.new(x509: x509)
      end

      class << self
        def to_x509(value)
          return value if value.is_a?(OpenSSL::X509::Certificate)

          value = Base64.decode64(strip(value)) if base64?(value)
          OpenSSL::X509::Certificate.new(value)
        end

        def base64?(value)
          return unless value.is_a?(String)

          sanitized_value = strip(value)
          !!sanitized_value.match(BASE64_FORMAT)
        end

        def strip(value)
          value
            .gsub(BEGIN_CERT, '')
            .gsub(END_CERT, '')
            .gsub(/[\r\n]|\\r|\\n|\s/, '')
        end
      end
    end
  end
end