oci 2.0.5 → 2.0.6

data/lib/oci/object_storage/models/preauthenticated_request_summary.rb

@@ -3,6 +3,8 @@
 require 'date'
 
 module OCI
+  # Get summary information about pre-authenticated requests.
+  #
   class ObjectStorage::Models::PreauthenticatedRequestSummary
 
     ACCESS_TYPE_ENUM = [ACCESS_TYPE_OBJECT_READ = 'ObjectRead',
@@ -11,11 +13,11 @@ module OCI
                 ACCESS_TYPE_ANY_OBJECT_WRITE = 'AnyObjectWrite',
                 ACCESS_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']
 
-    # The unique identifier to use when directly addressing the pre-authenticated request.
+    # **[Required]** The unique identifier to use when directly addressing the pre-authenticated request.
     # @return [String]
     attr_accessor :id
 
-    # The user-provided name of the pre-authenticated request.
+    # **[Required]** The user-provided name of the pre-authenticated request.
     # @return [String]
     attr_accessor :name
 
@@ -23,16 +25,16 @@ module OCI
     # @return [String]
     attr_accessor :object_name
 
-    # The operation that can be performed on this resource.
+    # **[Required]** The operation that can be performed on this resource.
     # @return [String]
     attr_accessor :access_type
 
-    # The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/rfc/rfc3339). After this date the pre-authenticated request will no longer be valid.
+    # **[Required]** The expiration date for the pre-authenticated request as per [RFC 3339](https://tools.ietf.org/rfc/rfc3339). After this date the pre-authenticated request will no longer be valid.
     # 
     # @return [DateTime]
     attr_accessor :time_expires
 
-    # The date when the pre-authenticated request was created as per [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
+    # **[Required]** The date when the pre-authenticated request was created as per [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
     # 
     # @return [DateTime]
     attr_accessor :time_created
@@ -40,6 +42,12 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :id The value to assign to the {#id} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [String] :objectName The value to assign to the {#object_name} property
+    # @option attributes [String] :accessType The value to assign to the {#access_type} property
+    # @option attributes [DateTime] :timeExpires The value to assign to the {#time_expires} property
+    # @option attributes [DateTime] :timeCreated The value to assign to the {#time_created} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/object_storage/models/rename_object_details.rb

@@ -3,12 +3,16 @@
 require 'date'
 
 module OCI
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access, see
+  # [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class ObjectStorage::Models::RenameObjectDetails
-    # The name of the source object to be renamed.
+    # **[Required]** The name of the source object to be renamed.
     # @return [String]
     attr_accessor :source_name
 
-    # The new name of the source object.
+    # **[Required]** The new name of the source object.
     # @return [String]
     attr_accessor :new_name
 
@@ -27,6 +31,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :sourceName The value to assign to the {#source_name} property
+    # @option attributes [String] :newName The value to assign to the {#new_name} property
+    # @option attributes [String] :srcObjIfMatchETag The value to assign to the {#src_obj_if_match_e_tag} property
+    # @option attributes [String] :newObjIfMatchETag The value to assign to the {#new_obj_if_match_e_tag} property
+    # @option attributes [String] :newObjIfNoneMatchETag The value to assign to the {#new_obj_if_none_match_e_tag} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/object_storage/models/restore_objects_details.rb

@@ -4,13 +4,14 @@ require 'date'
 
 module OCI
   class ObjectStorage::Models::RestoreObjectsDetails
-    # A object which was in an archived state and need to be restored.
+    # **[Required]** A object which was in an archived state and need to be restored.
     # @return [String]
     attr_accessor :object_name
 
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :objectName The value to assign to the {#object_name} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/object_storage/models/update_bucket_details.rb

@@ -3,10 +3,15 @@
 require 'date'
 
 module OCI
+  # To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
+  # talk to an administrator. If you're an administrator who needs to write policies to give users access, see
+  # [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
+  #
   class ObjectStorage::Models::UpdateBucketDetails
 
     PUBLIC_ACCESS_TYPE_ENUM = [PUBLIC_ACCESS_TYPE_NO_PUBLIC_ACCESS = 'NoPublicAccess',
-                PUBLIC_ACCESS_TYPE_OBJECT_READ = 'ObjectRead']
+                PUBLIC_ACCESS_TYPE_OBJECT_READ = 'ObjectRead',
+                PUBLIC_ACCESS_TYPE_OBJECT_READ_WITHOUT_LIST = 'ObjectReadWithoutList']
 
     # The namespace in which the bucket lives.
     # @return [String]
@@ -28,7 +33,8 @@ module OCI
 
     # The type of public access enabled on this bucket. A bucket is set to `NoPublicAccess` by default, which only allows an
     # authenticated caller to access the bucket and its contents. When `ObjectRead` is enabled on the bucket, public access
-    # is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations.
+    # is allowed for the `GetObject`, `HeadObject`, and `ListObjects` operations. When `ObjectReadWithoutList` is enabled
+    # on the bucket, public access is allowed for the `GetObject` and `HeadObject` operations.
     # 
     # @return [String]
     attr_accessor :public_access_type
@@ -36,6 +42,11 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :namespace The value to assign to the {#namespace} property
+    # @option attributes [String] :compartmentId The value to assign to the {#compartment_id} property
+    # @option attributes [String] :name The value to assign to the {#name} property
+    # @option attributes [Hash<String, String>] :metadata The value to assign to the {#metadata} property
+    # @option attributes [String] :publicAccessType The value to assign to the {#public_access_type} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/object_storage/models/update_namespace_metadata_details.rb

@@ -3,6 +3,9 @@
 require 'date'
 
 module OCI
+  # An UpdateNamespaceMetadataDetails is used for update NamespaceMetadata. To be able to upate the NamespaceMetadata, a user
+  #  must have NAMESPACE_UPDATE permission.
+  #
   class ObjectStorage::Models::UpdateNamespaceMetadataDetails
     # The update compartment id for an S3 client if this field is set.
     # @return [String]
@@ -15,6 +18,8 @@ module OCI
 
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :defaultS3CompartmentId The value to assign to the {#default_s3_compartment_id} property
+    # @option attributes [String] :defaultSwiftCompartmentId The value to assign to the {#default_swift_compartment_id} property
     def initialize(attributes = {})
       return unless attributes.is_a?(Hash)
 

data/lib/oci/object_storage/object_storage_client.rb

@@ -28,15 +28,29 @@ module OCI
     # @param [Config] config A Config object.
     # @param [String] region A region used to determine the service endpoint. This will usually
     #   correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.
-    #
-    def initialize(config:nil, region:nil)
-      config ||= OCI.config
-      config.validate
+    # @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then
+    #   a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication,
+    #   so that the instance principals signer can be provided to the client
+    def initialize(config:nil, region:nil, signer:nil)
+      # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals)
+      # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
+      # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
+      # pass it to this constructor.
+      #
+      # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
+      # so try and load the config from the default file.
+      config ||= OCI.config unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+      config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
+
+      if signer.nil?
+        signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::OBJECT_STORAGE)
+      end
 
-      signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::OBJECT_STORAGE)
       @api_client = ApiClient.new(config, signer)
 
       region ||= config.region
+      region ||= signer.region if signer.respond_to?(:region)
       self.region = region
     end
 
@@ -452,8 +466,8 @@ module OCI
         :return_type => 'OCI::ObjectStorage::Models::Bucket')
     end
 
-    # Gets the name of the namespace for the user making the request. An account name must be unique, must start with a
-    # letter, and can have up to 15 lowercase letters and numbers. You cannot use spaces or special characters.
+    # Namespaces are unique. Namespaces are either the tenancy name or a random string automatically generated during
+    # account creation. You cannot edit a namespace.
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :opc_client_request_id The client request ID for tracing.
@@ -761,7 +775,7 @@ module OCI
     # [Getting Started with Policies](https://docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policygetstarted.htm).
     # 
     # @param [String] namespace_name The top-level namespace used for the request.
-    # @param [String] compartment_id The ID of the compartment in which to create the bucket.
+    # @param [String] compartment_id The ID of the compartment in which to list buckets.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit The maximum number of items to return.
     # @option opts [String] :page The page at which to start retrieving results.
@@ -906,10 +920,10 @@ module OCI
     # @option opts [String] :_end Object names returned by a list query must be strictly less than this parameter.
     # @option opts [Integer] :limit The maximum number of items to return.
     # @option opts [String] :delimiter When this parameter is set, only objects whose names do not contain the delimiter character
-    #   (after an optionally specified prefix) are returned. Scanned objects whose names contain the
-    #   delimiter have part of their name up to the last occurrence of the delimiter (after the optional
-    #   prefix) returned as a set of prefixes. Note that only '/' is a supported delimiter character at
-    #   this time.
+    #   (after an optionally specified prefix) are returned in the objects key of the response body.
+    #   Scanned objects whose names contain the delimiter have the part of their name up to the first
+    #   occurrence of the delimiter (including the optional prefix) returned as a set of prefixes.
+    #   Note that only '/' is a supported delimiter character at this time.
     #   
     # @option opts [String] :fields Object summary in list of objects includes the 'name' field. This parameter can also include 'size'
     #   (object size in bytes), 'md5', and 'timeCreated' (object creation date and time) fields.

data/lib/oci/regions.rb

@@ -9,6 +9,12 @@ module OCI
       REGION_EU_FRANKFURT_1 = 'eu-frankfurt-1'.freeze
     ].freeze
 
+    REGION_SHORT_NAMES_TO_LONG_NAMES = {
+      'phx': REGION_US_PHOENIX_1,
+      'iad': REGION_US_ASHBURN_1,
+      'fra': REGION_EU_FRANKFURT_1
+    }.freeze
+
     SERVICE_ENDPOINT_PREFIX_MAPPING = {
       BlockstorageClient: 'iaas',
       ComputeClient: 'iaas',
@@ -17,7 +23,8 @@ module OCI
       LoadBalancerClient: 'iaas',
       ObjectStorageClient: 'objectstorage',
       DatabaseClient: 'database',
-      AuditClient: 'audit'
+      AuditClient: 'audit',
+      Auth: 'auth'
     }.freeze
 
     # Returns an endpoint for the given region and service.

data/lib/oci/signer.rb

@@ -8,16 +8,15 @@ require 'time'
 require 'uri'
 require 'cgi'
 
+require_relative 'base_signer'
+
 module OCI
 
   # Used to sign HTTP requests as required by Oracle Cloud Infrastructure.
-  class Signer
+  class Signer < BaseSigner
     # enum to define the signing strategy
     SIGNING_STRATEGY_ENUM = [STANDARD = 'standard', OBJECT_STORAGE = 'object_storage']
 
-    # The Oracle Cloud Infrastructure API signature version
-    SIGNATURE_VERSION = "1"
-
     # Creates a Signer
     #
     # @param [String] user OCID of the user to be used for authentication, for example "ocidv1:user:oc1:phx:1460406592659:aaaaaaaawcbqrkycbolrirg2n3xjl5fyxe".
@@ -33,126 +32,8 @@ module OCI
       fail 'Missing required parameter tenancy.' unless tenancy
       fail 'Missing required parameter private_key_file or private_key_content.' unless private_key_file || private_key_content
 
-      @key_id = tenancy + "/" + user + "/" + fingerprint
-      @private_key_file = private_key_file
-      @private_key_content = private_key_content
-      @pass_phrase = pass_phrase
-      @signing_strategy = signing_strategy
-    end
-
-    # Generates the correct signature and adds it to the
-    # headers that are passed in. Also injects any required
-    # headers that might be missing.
-    #
-    # @param [Symbol] method The HTTP method, such as :get or :post.
-    # @param [String] uri The URI, such as 'https://iaas.us-phoenix-1.oraclecloud.com/20160918/volumeAttachments/'
-    # @param [Hash] headers A hash of headers
-    # @param [String] body The request body
-    def sign(method, uri, headers, body)
-      method = method.to_sym.downcase
-      uri = URI(uri)
-      path = uri.query.nil? ? uri.path : "#{uri.path}?#{uri.query}"
-      inject_missing_headers(method, headers, body, uri)
-      signature = compute_signature(headers, method, path)
-      unless signature.nil?
-        inject_authorization_header(headers, method, signature)
-      end
-    end
-
-    private
-
-    GENERIC_HEADERS = [:"date", :"(request-target)", :"host"]
-    BODY_HEADERS = [:"content-length", :"content-type", :"x-content-sha256"]
-
-    OPERATION_HEADER_MAPPING = {
-      options: [],
-      get: GENERIC_HEADERS,
-      head: GENERIC_HEADERS,
-      delete: GENERIC_HEADERS,
-      put: GENERIC_HEADERS + BODY_HEADERS,
-      post: GENERIC_HEADERS + BODY_HEADERS,
-      patch: GENERIC_HEADERS + BODY_HEADERS
-    }.freeze
-
-    def inject_missing_headers(method, headers, body, uri)
-
-      headers["date"] ||= Time.now.utc.httpdate
-      headers["accept"] ||= "*/*"
-      headers["host"] ||= uri.host
-
-      # For object storage service's put method, we don't need to set content type
-      if method != :put || @signing_strategy != OBJECT_STORAGE
-        headers["content-type"] ||= "application/json"
-      else
-        headers[:'Content-Type'] ||= 'application/octet-stream'
-      end
-
-      if method == :put || method == :post
-        body ||= ''
-
-        # For object storage service's put method, we don't need to set content length and x-content sha256
-        if method != :put || @signing_strategy != OBJECT_STORAGE
-          headers["content-length"] ||= body.length.to_s
-          headers["x-content-sha256"] ||= Digest::SHA256.base64digest(body)
-        else
-          if body.respond_to?(:read) && body.respond_to?(:write)
-            headers['Content-Length'] ||= body.respond_to?('size') ? body.size : body.stat.size
-          else
-            headers['Content-Length'] ||= body.length.to_s
-          end
-        end
-      end
-    end
-
-    def inject_authorization_header(headers, method, signature)
-
-      if method == :put && @signing_strategy == OBJECT_STORAGE
-        header_mapping = GENERIC_HEADERS
-      else
-        header_mapping = OPERATION_HEADER_MAPPING[method]
-      end
-
-      signed_headers = header_mapping.map(&:to_s).join(" ")
-      headers["authorization"] = [
-          %(Signature headers="#{signed_headers}"),
-          %(keyId="#{@key_id}"),
-          %(algorithm="rsa-sha256"),
-          %(signature="#{signature}"),
-          %(version="#{SIGNATURE_VERSION}")
-      ].join(",")
-    end
-
-    def compute_signature(headers, method, path)
-      if method == :put && @signing_strategy == OBJECT_STORAGE
-        header_mapping = GENERIC_HEADERS
-      else
-        header_mapping = OPERATION_HEADER_MAPPING[method]
-      end
-
-      return if header_mapping.empty?
-      signing_string = header_mapping.map do |header|
-        if header == :"(request-target)"
-          "#{header}: #{method.downcase} #{path}"
-        else
-          "#{header}: #{headers[header.to_s]}"
-        end
-      end.join("\n")
-
-      signature = private_key.sign(OpenSSL::Digest::SHA256.new, signing_string.encode("ascii"))
-      Base64.strict_encode64(signature)
-    end
-
-    def private_key
-      # If a pass_phase was not provided and the key is in fact encrypted, then passing in
-      # nil for the passphrase here will show a user prompt and block until there is a response.
-      # Passing in an empty string will work for some versions of Ruby's openssl wrapper, but
-      # other versions will enforce the 4 character password minimum at this point. Passing in
-      # a dummy password that's greater than 4 characters avoids both problems, and will
-      # always succeed if the file is not encrypted.
-      @private_key ||= OpenSSL::PKey::RSA.new(
-          @private_key_content.nil? ? File.read(@private_key_file) : @private_key_content,
-          @pass_phrase || SecureRandom.uuid)
+      private_key = private_key_content.nil? ? File.read(private_key_file) : private_key_content
+      super("#{tenancy}/#{user}/#{fingerprint}", private_key, pass_phrase: pass_phrase, signing_strategy: signing_strategy)
     end
   end
-
 end

data/lib/oci/version.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
 
 module OCI
-  VERSION = '2.0.5'.freeze
+  VERSION = '2.0.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oci
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Oracle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -50,6 +50,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +153,17 @@ files:
 - "./lib/oci/audit/models/configuration.rb"
 - "./lib/oci/audit/models/update_configuration_details.rb"
 - "./lib/oci/audit/util.rb"
+- "./lib/oci/auth/auth.rb"
+- "./lib/oci/auth/federation_client.rb"
+- "./lib/oci/auth/internal/auth_token_request_signer.rb"
+- "./lib/oci/auth/security_token_container.rb"
+- "./lib/oci/auth/session_key_supplier.rb"
+- "./lib/oci/auth/signers/instance_principals_security_token_signer.rb"
+- "./lib/oci/auth/signers/security_token_signer.rb"
+- "./lib/oci/auth/signers/x509_federation_client_based_security_token_signer.rb"
+- "./lib/oci/auth/url_based_certificate_retriever.rb"
+- "./lib/oci/auth/util.rb"
+- "./lib/oci/base_signer.rb"
 - "./lib/oci/config.rb"
 - "./lib/oci/config_file_loader.rb"
 - "./lib/oci/core/blockstorage_client.rb"
@@ -314,6 +339,7 @@ files:
 - "./lib/oci/identity/models/create_api_key_details.rb"
 - "./lib/oci/identity/models/create_compartment_details.rb"
 - "./lib/oci/identity/models/create_customer_secret_key_details.rb"
+- "./lib/oci/identity/models/create_dynamic_group_details.rb"
 - "./lib/oci/identity/models/create_group_details.rb"
 - "./lib/oci/identity/models/create_identity_provider_details.rb"
 - "./lib/oci/identity/models/create_idp_group_mapping_details.rb"
@@ -326,6 +352,7 @@ files:
 - "./lib/oci/identity/models/create_user_details.rb"
 - "./lib/oci/identity/models/customer_secret_key.rb"
 - "./lib/oci/identity/models/customer_secret_key_summary.rb"
+- "./lib/oci/identity/models/dynamic_group.rb"
 - "./lib/oci/identity/models/group.rb"
 - "./lib/oci/identity/models/identity_provider.rb"
 - "./lib/oci/identity/models/idp_group_mapping.rb"
@@ -342,6 +369,7 @@ files:
 - "./lib/oci/identity/models/ui_password.rb"
 - "./lib/oci/identity/models/update_compartment_details.rb"
 - "./lib/oci/identity/models/update_customer_secret_key_details.rb"
+- "./lib/oci/identity/models/update_dynamic_group_details.rb"
 - "./lib/oci/identity/models/update_group_details.rb"
 - "./lib/oci/identity/models/update_identity_provider_details.rb"
 - "./lib/oci/identity/models/update_idp_group_mapping_details.rb"
@@ -367,6 +395,7 @@ files:
 - "./lib/oci/load_balancer/models/backend_set_health.rb"
 - "./lib/oci/load_balancer/models/certificate.rb"
 - "./lib/oci/load_balancer/models/certificate_details.rb"
+- "./lib/oci/load_balancer/models/connection_configuration.rb"
 - "./lib/oci/load_balancer/models/create_backend_details.rb"
 - "./lib/oci/load_balancer/models/create_backend_set_details.rb"
 - "./lib/oci/load_balancer/models/create_certificate_details.rb"