akeyless 3.3.4 → 3.3.6

data/lib/akeyless/models/create_key.rb

@@ -19,6 +19,27 @@ module Akeyless
     # Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, AES128CBC, AES256CBC, RSA1024, RSA2048, RSA3072, RSA4096]
     attr_accessor :alg
 
+    # Common name for the generated certificate. Relevant only for generate-self-signed-certificate.
+    attr_accessor :certificate_common_name
+
+    # Country name for the generated certificate. Relevant only for generate-self-signed-certificate.
+    attr_accessor :certificate_country
+
+    # Digest algorithm to be used for the certificate key signing. Currently, we support only \"sha256\" so we hide this option for CLI.
+    attr_accessor :certificate_digest_algo
+
+    # Locality for the generated certificate. Relevant only for generate-self-signed-certificate.
+    attr_accessor :certificate_locality
+
+    # Organization name for the generated certificate. Relevant only for generate-self-signed-certificate.
+    attr_accessor :certificate_organization
+
+    # Province name for the generated certificate. Relevant only for generate-self-signed-certificate.
+    attr_accessor :certificate_province
+
+    # TTL in days for the generated certificate. Required only for generate-self-signed-certificate.
+    attr_accessor :certificate_ttl
+
     # The customer fragment ID that will be used to create the key (if empty, the key will be created independently of a customer fragment)
     attr_accessor :customer_frg_id
 
@@ -28,6 +49,9 @@ module Akeyless
     # Description of the object
     attr_accessor :description
 
+    # Whether to generate a self signed certificate with the key. If set, --certificate-ttl must be provided.
+    attr_accessor :generate_self_signed_certificate
+
     # Set output format to JSON
     attr_accessor :json
 
@@ -53,9 +77,17 @@ module Akeyless
     def self.attribute_map
       {
         :'alg' => :'alg',
+        :'certificate_common_name' => :'certificate-common-name',
+        :'certificate_country' => :'certificate-country',
+        :'certificate_digest_algo' => :'certificate-digest-algo',
+        :'certificate_locality' => :'certificate-locality',
+        :'certificate_organization' => :'certificate-organization',
+        :'certificate_province' => :'certificate-province',
+        :'certificate_ttl' => :'certificate-ttl',
         :'customer_frg_id' => :'customer-frg-id',
         :'delete_protection' => :'delete_protection',
         :'description' => :'description',
+        :'generate_self_signed_certificate' => :'generate-self-signed-certificate',
         :'json' => :'json',
         :'metadata' => :'metadata',
         :'name' => :'name',
@@ -75,9 +107,17 @@ module Akeyless
     def self.openapi_types
       {
         :'alg' => :'String',
+        :'certificate_common_name' => :'String',
+        :'certificate_country' => :'String',
+        :'certificate_digest_algo' => :'String',
+        :'certificate_locality' => :'String',
+        :'certificate_organization' => :'String',
+        :'certificate_province' => :'String',
+        :'certificate_ttl' => :'Integer',
         :'customer_frg_id' => :'String',
         :'delete_protection' => :'String',
         :'description' => :'String',
+        :'generate_self_signed_certificate' => :'Boolean',
         :'json' => :'Boolean',
         :'metadata' => :'String',
         :'name' => :'String',
@@ -113,6 +153,34 @@ module Akeyless
         self.alg = attributes[:'alg']
       end
 
+      if attributes.key?(:'certificate_common_name')
+        self.certificate_common_name = attributes[:'certificate_common_name']
+      end
+
+      if attributes.key?(:'certificate_country')
+        self.certificate_country = attributes[:'certificate_country']
+      end
+
+      if attributes.key?(:'certificate_digest_algo')
+        self.certificate_digest_algo = attributes[:'certificate_digest_algo']
+      end
+
+      if attributes.key?(:'certificate_locality')
+        self.certificate_locality = attributes[:'certificate_locality']
+      end
+
+      if attributes.key?(:'certificate_organization')
+        self.certificate_organization = attributes[:'certificate_organization']
+      end
+
+      if attributes.key?(:'certificate_province')
+        self.certificate_province = attributes[:'certificate_province']
+      end
+
+      if attributes.key?(:'certificate_ttl')
+        self.certificate_ttl = attributes[:'certificate_ttl']
+      end
+
       if attributes.key?(:'customer_frg_id')
         self.customer_frg_id = attributes[:'customer_frg_id']
       end
@@ -125,6 +193,10 @@ module Akeyless
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'generate_self_signed_certificate')
+        self.generate_self_signed_certificate = attributes[:'generate_self_signed_certificate']
+      end
+
       if attributes.key?(:'json')
         self.json = attributes[:'json']
       else
@@ -189,9 +261,17 @@ module Akeyless
       return true if self.equal?(o)
       self.class == o.class &&
           alg == o.alg &&
+          certificate_common_name == o.certificate_common_name &&
+          certificate_country == o.certificate_country &&
+          certificate_digest_algo == o.certificate_digest_algo &&
+          certificate_locality == o.certificate_locality &&
+          certificate_organization == o.certificate_organization &&
+          certificate_province == o.certificate_province &&
+          certificate_ttl == o.certificate_ttl &&
           customer_frg_id == o.customer_frg_id &&
           delete_protection == o.delete_protection &&
           description == o.description &&
+          generate_self_signed_certificate == o.generate_self_signed_certificate &&
           json == o.json &&
           metadata == o.metadata &&
           name == o.name &&
@@ -210,7 +290,7 @@ module Akeyless
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [alg, customer_frg_id, delete_protection, description, json, metadata, name, split_level, tag, token, uid_token].hash
+      [alg, certificate_common_name, certificate_country, certificate_digest_algo, certificate_locality, certificate_organization, certificate_province, certificate_ttl, customer_frg_id, delete_protection, description, generate_self_signed_certificate, json, metadata, name, split_level, tag, token, uid_token].hash
     end
 
     # Builds the object from hash

data/lib/akeyless/models/derive_key.rb

@@ -0,0 +1,362 @@
+=begin
+#Akeyless API
+
+#The purpose of this application is to provide access to Akeyless API.
+
+The version of the OpenAPI document: 2.0
+Contact: support@akeyless.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module Akeyless
+  class DeriveKey
+    # for personal password manager
+    attr_accessor :accessibility
+
+    # Kdf algorithm
+    attr_accessor :alg
+
+    # HashFunction the hash function to use (relevant for pbkdf2)
+    attr_accessor :hash_function
+
+    # IterationCount the number of iterations
+    attr_accessor :iter
+
+    # Set output format to JSON
+    attr_accessor :json
+
+    # KeyLength the byte length of the generated key
+    attr_accessor :key_len
+
+    # MemorySizeInKb the memory paramter in kb (relevant for argon2id)
+    attr_accessor :mem
+
+    # Static Secret full name
+    attr_accessor :name
+
+    # Parallelism the number of threads to use (relevant for argon2id)
+    attr_accessor :parallelism
+
+    # Salt Base64 encoded salt value. If not provided, the salt will be generated as part of the operation. The salt should be securely-generated random bytes, minimum 64 bits, 128 bits is recommended
+    attr_accessor :salt
+
+    # Authentication token (see `/auth` and `/configure`)
+    attr_accessor :token
+
+    # The universal identity token, Required only for universal_identity authentication
+    attr_accessor :uid_token
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'accessibility' => :'accessibility',
+        :'alg' => :'alg',
+        :'hash_function' => :'hash-function',
+        :'iter' => :'iter',
+        :'json' => :'json',
+        :'key_len' => :'key-len',
+        :'mem' => :'mem',
+        :'name' => :'name',
+        :'parallelism' => :'parallelism',
+        :'salt' => :'salt',
+        :'token' => :'token',
+        :'uid_token' => :'uid-token'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'accessibility' => :'String',
+        :'alg' => :'String',
+        :'hash_function' => :'String',
+        :'iter' => :'Integer',
+        :'json' => :'Boolean',
+        :'key_len' => :'Integer',
+        :'mem' => :'Integer',
+        :'name' => :'String',
+        :'parallelism' => :'Integer',
+        :'salt' => :'String',
+        :'token' => :'String',
+        :'uid_token' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::DeriveKey` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::DeriveKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'accessibility')
+        self.accessibility = attributes[:'accessibility']
+      else
+        self.accessibility = 'regular'
+      end
+
+      if attributes.key?(:'alg')
+        self.alg = attributes[:'alg']
+      else
+        self.alg = 'pbkdf2'
+      end
+
+      if attributes.key?(:'hash_function')
+        self.hash_function = attributes[:'hash_function']
+      else
+        self.hash_function = 'sha256'
+      end
+
+      if attributes.key?(:'iter')
+        self.iter = attributes[:'iter']
+      end
+
+      if attributes.key?(:'json')
+        self.json = attributes[:'json']
+      else
+        self.json = false
+      end
+
+      if attributes.key?(:'key_len')
+        self.key_len = attributes[:'key_len']
+      end
+
+      if attributes.key?(:'mem')
+        self.mem = attributes[:'mem']
+      else
+        self.mem = 16384
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'parallelism')
+        self.parallelism = attributes[:'parallelism']
+      else
+        self.parallelism = 1
+      end
+
+      if attributes.key?(:'salt')
+        self.salt = attributes[:'salt']
+      end
+
+      if attributes.key?(:'token')
+        self.token = attributes[:'token']
+      end
+
+      if attributes.key?(:'uid_token')
+        self.uid_token = attributes[:'uid_token']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @alg.nil?
+        invalid_properties.push('invalid value for "alg", alg cannot be nil.')
+      end
+
+      if @iter.nil?
+        invalid_properties.push('invalid value for "iter", iter cannot be nil.')
+      end
+
+      if @key_len.nil?
+        invalid_properties.push('invalid value for "key_len", key_len cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @alg.nil?
+      return false if @iter.nil?
+      return false if @key_len.nil?
+      return false if @name.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          accessibility == o.accessibility &&
+          alg == o.alg &&
+          hash_function == o.hash_function &&
+          iter == o.iter &&
+          json == o.json &&
+          key_len == o.key_len &&
+          mem == o.mem &&
+          name == o.name &&
+          parallelism == o.parallelism &&
+          salt == o.salt &&
+          token == o.token &&
+          uid_token == o.uid_token
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [accessibility, alg, hash_function, iter, json, key_len, mem, name, parallelism, salt, token, uid_token].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Akeyless.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end