# frozen_string_literal: true
#
# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
#
# Ronin Support is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
# by the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ronin Support is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with Ronin Support.  If not, see <http://www.gnu.org/licenses/>.
#

require 'ronin/support/crypto/openssl'

module Ronin
  module Support
    module Crypto
      module Key
        #
        # Common methods for {Key} classes.
        #
        # @api private
        #
        # @since 1.0.0
        #
        module Methods
          #
          # Extends {ClassMethods}.
          #
          # @param [Class] key_class
          #   The {Key} class that is including {Methods}.
          #
          def self.included(key_class)
            key_class.extend ClassMethods
          end

          #
          # Class-methods.
          #
          module ClassMethods
            #
            # Generates a new random key.
            #
            # @param [Array] arguments
            #   Additional arguments for `generate`.
            #
            # @return [Class<Methods>]
            #   The newly generated key.
            #
            # @note Alias for `generate`.
            #
            def random(*arguments,&block)
              generate(*arguments,&block)
            end

            #
            # Parses an PEM encoded key.
            #
            # @param [String] key
            #   The PEM or DER encoded key string.
            #
            # @param [String, nil] password
            #   Optional password to decrypt the key.
            #
            # @return [OpenSSL::PKey]
            #   The parsed key.
            #
            # @api public
            #
            def parse(key, password: nil)
              new(key,*password)
            end

            #
            # Alias for {#parse}.
            #
            # @param [String] key
            #   The PEM or DER encoded key string.
            #
            # @param [Hash{Symbol => Object}] kwargs
            #   Additional keyword arguments for {#parse}.
            #
            # @option kwargs [String, nil] :password
            #   Optional password to decrypt the key.
            #
            # @return [OpenSSL::PKey]
            #   The parsed key.
            #
            # @see parse
            #
            # @api public
            #
            def load(key,**kwargs)
              parse(key,**kwargs)
            end

            #
            # Loads a key from a file.
            #
            # @param [String] path
            #   The path to the PEM or DER encoded key file.
            #
            # @param [Hash{Symbol => Object}] kwargs
            #   Additional keyword arguments for {parse}.
            #
            # @option kwargs [String, nil] :password
            #   Optional password to decrypt the key.
            #
            # @return [OpenSSL::PKey]
            #   The parsed key.
            #
            # @api public
            #
            def load_file(path,**kwargs)
              parse(File.read(path),**kwargs)
            end
          end

          #
          # Saves the key to the given path.
          #
          # @param [String] path
          #   The path to write the exported key to.
          #
          # @param [:pem, :der] encoding
          #   The desired encoding of the exported key.
          #   * `:pem` - PEM encoding.
          #   * `:der` - DER encoding.
          #
          # @param [String, nil] cipher
          #   Optional cipher to use to encrypt the key file.
          #
          # @param [String, nil] password
          #   Optional password to use to encrypt the key file.
          #
          # @raise [ArgumentError]
          #   The `endcoding:` value must be either `:pem` or `:der`.
          #
          def save(path, encoding: :pem, cipher: 'aes-256-cbc', password: nil)
            encoding_method = case encoding
                              when :pem then method(:to_pem)
                              when :der then method(:to_der)
                              else
                                raise(ArgumentError,"encoding: keyword argument (#{encoding.inspect}) must be either :pem or :der")
                              end

            exported = if password
                         cipher = OpenSSL::Cipher.new(cipher)
                         encoding_method.call(cipher,password)
                       else
                         encoding_method.call
                       end

            File.write(path,exported)
          end
        end
      end
    end
  end
end