gitlab-secret_detection 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 648b6d5277ac8e7948762533af39dc2f4ff0ae4c62fbdcc6d5d32615a44ab815
-  data.tar.gz: afd2a580cb0a73bb84a401616ec622e1e14d2b75021036a959f933ed75864cf6
+  metadata.gz: ff032818993f54b85b958ad43293df4e9112ad20b9d68ab654abf74ebeb778a7
+  data.tar.gz: e0556ec3bc97e6973bbb6c8ba4e041897eccfbb37e23d4af16ff4fccd4850eb0
 SHA512:
-  metadata.gz: 7c49b71891f6e13d8dc252936f18df838d8e9d42000cbc1f4f3d7fe56b258a7e2c17bce7a7f0e771bc16991fa46bacf641a636a1d1efd3ef23de6b0a31a011b8
-  data.tar.gz: af93c82a0025be12bc82fe6ff62b290fe193a2338ae2f98d83bc2729d1c7cc35a223330a3a9907a9f715c009127e93ba2d13fc33982d2f13a179d8548f5cc36e
+  metadata.gz: ae963ac226ddab5d154879c078b44581f859232175ecf69269818a0e880368855469f10265a63d408089b5da7d56e37f51a865bbd9efc66ddd5474d1b718af0a
+  data.tar.gz: ff4c2bff936d88972a1e51563e2f6a0fb61f3c431213058fccae5e7abd18ac72636e37099a0dece9f083424795078bf2b69dd224aa88b27e6752bed1ae9d37ee

data/README.md

@@ -329,9 +329,9 @@ Secret Detection service's status can be tracked here: https://gitlab.com/gitlab
 
 #### Changes made in the secret detection logic that were previously not present in the Gem
 
-- [GitLab::SecretDetection::Core::Scanner#initialize(...)](lib/gitlab/secret_detection/core/scanner.rb): To reuse the logic of ruleset parsing from a file source, we parse the ruleset file at once and pass the parsed rules around. So,
+- [Gitlab::SecretDetection::Core::Scanner#initialize(...)](lib/gitlab/secret_detection/core/scanner.rb): To reuse the logic of ruleset parsing from a file source, we parse the ruleset file at once and pass the parsed rules around. So,
 the `initialize()` method now accepts parsed rules instead of ruleset file path
-- [GitLab::SecretDetection::Core::Status](lib/gitlab/secret_detection/core/status.rb): `NOT_FOUND` status moved from `0` to `7` since
+- [Gitlab::SecretDetection::Core::Status](lib/gitlab/secret_detection/core/status.rb): `NOT_FOUND` status moved from `0` to `7` since
 gRPC reserves `0` for enums. We need to reflect this change on the Rails side too
-- [GitLab::SecretDetection::Core::Scanner#scan(...)](lib/gitlab/secret_detection/core/scanner.rb): Introduced `rule_exclusions`, `raw_value_exclusions` and `tags` args to `scan(..)`
+- [Gitlab::SecretDetection::Core::Scanner#scan(...)](lib/gitlab/secret_detection/core/scanner.rb): Introduced `rule_exclusions`, `raw_value_exclusions` and `tags` args to `scan(..)`
 method to suport [exclusions](https://gitlab.com/groups/gitlab-org/-/epics/14315) feature.

data/lib/gitlab/secret_detection/core/finding.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Core
       # Finding is a data object representing a secret finding identified within a payload

data/lib/gitlab/secret_detection/core/response.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Core
       # Response is the data object returned by the scan operation with the following structure
       #
-      # +status+:: One of values from GitLab::SecretDetection::Core::Status indicating the scan operation's status
-      # +results+:: Array of GitLab::SecretDetection::Core::Finding values. Default value is nil.
+      # +status+:: One of values from Gitlab::SecretDetection::Core::Status indicating the scan operation's status
+      # +results+:: Array of Gitlab::SecretDetection::Core::Finding values. Default value is nil.
       # +metadata+:: Hash object containing additional meta information about the response. It is currently used
       #   to embed more information on error.
       class Response

data/lib/gitlab/secret_detection/core/ruleset.rb

@@ -3,7 +3,7 @@
 require 'toml-rb'
 require 'logger'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Core
       class Ruleset

data/lib/gitlab/secret_detection/core/scanner.rb

@@ -6,7 +6,7 @@ require 'timeout'
 require 'English'
 require 'parallel'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Core
       # Scan is responsible for running Secret Detection scan operation
@@ -61,7 +61,7 @@ module GitLab
         #                  the scan duration on each payload
         # +raw_value_exclusions:+:: Array of raw values to exclude from the scan.
         # +rule_exclusions+:: Array of rules to exclude from the ruleset used for the scan. Each rule is represented
-        #           by its ID. For example: `gitlab_personal_access_token` for representing GitLab Personal Access
+        #           by its ID. For example: `gitlab_personal_access_token` for representing Gitlab Personal Access
         #           Token. By default, no rule is excluded from the ruleset.
         # +tags+:: Array of tag values to filter from the default ruleset when determining the rules used for the scan.
         #           For example: Add `gitlab_blocking` to include only rules for Push Protection. Defaults to
@@ -74,7 +74,7 @@ module GitLab
         # forking a new process adds to the overall latency of the scan instead. More reference on Subprocess-based
         # execution is found here: https://gitlab.com/gitlab-org/gitlab/-/issues/430160.
         #
-        # Returns an instance of GitLab::SecretDetection::Core::Response by following below structure:
+        # Returns an instance of Gitlab::SecretDetection::Core::Response by following below structure:
         # {
         #     status: One of the Core::Status values
         #     results: [SecretDetection::Finding]

data/lib/gitlab/secret_detection/core/status.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Core
       # All the possible statuses emitted by the scan operation

data/lib/gitlab/secret_detection/core.rb

@@ -6,7 +6,7 @@ require_relative 'core/status'
 require_relative 'core/scanner'
 require_relative 'core/ruleset'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Core
     end

data/lib/gitlab/secret_detection/grpc/client/grpc_client.rb

@@ -7,7 +7,7 @@ require_relative '../../core/status'
 require_relative '../../utils'
 require_relative './stream_request_enumerator'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module GRPC
       class Client
@@ -24,9 +24,9 @@ module GitLab
         end
 
         # Triggers Secret Detection service's `/Scan` gRPC endpoint. To keep it consistent with SDS gem interface,
-        # this method transforms the gRPC response to +GitLab::SecretDetection::Core::Response+.
+        # this method transforms the gRPC response to +Gitlab::SecretDetection::Core::Response+.
         # Furthermore, any errors that are raised by the service will be translated to
-        # +GitLab::SecretDetection::Core::Response+ type by assiging a appropriate +status+ value to it.
+        # +Gitlab::SecretDetection::Core::Response+ type by assiging a appropriate +status+ value to it.
         def run_scan(request:, auth_token:, extra_headers: {})
           with_rescued_errors do
             grpc_response = stub.scan(
@@ -42,13 +42,13 @@ module GitLab
         # Triggers Secret Detection service's `/ScanStream` gRPC endpoint.
         #
         # To keep it consistent with SDS gem interface, this method transforms the gRPC response to
-        # +GitLab::SecretDetection::Core::Response+ type. Furthermore, any errors that are raised by the service will be
-        # translated to +GitLab::SecretDetection::Core::Response+ type by assiging a appropriate +status+ value to it.
+        # +Gitlab::SecretDetection::Core::Response+ type. Furthermore, any errors that are raised by the service will be
+        # translated to +Gitlab::SecretDetection::Core::Response+ type by assiging a appropriate +status+ value to it.
         #
         # Note: If one of the stream requests result in an error, the stream will end immediately without processing the
         # remaining requests.
         def run_scan_stream(requests:, auth_token:, extra_headers: {})
-          request_stream = GitLab::SecretDetection::GRPC::StreamRequestEnumerator.new(requests)
+          request_stream = Gitlab::SecretDetection::GRPC::StreamRequestEnumerator.new(requests)
           results = []
           with_rescued_errors do
             stub.scan_stream(
@@ -72,7 +72,7 @@ module GitLab
         attr_reader :secure, :host, :compression
 
         def stub
-          GitLab::SecretDetection::GRPC::Scanner::Stub.new(
+          Gitlab::SecretDetection::GRPC::Scanner::Stub.new(
             host,
             channel_credentials,
             channel_args:
@@ -100,7 +100,7 @@ module GitLab
         def channel_credentials
           return :this_channel_is_insecure unless secure
 
-          certs = GitLab::SecretDetection::Utils::X509::Certificate.ca_certs_bundle
+          certs = Gitlab::SecretDetection::Utils::X509::Certificate.ca_certs_bundle
 
           ::GRPC::Core::ChannelCredentials.new(certs)
         end

data/lib/gitlab/secret_detection/grpc/client/stream_request_enumerator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GitLab
+module Gitlab
   module SecretDetection
     module GRPC
       class StreamRequestEnumerator

data/lib/gitlab/secret_detection/grpc/generated/secret_detection_pb.rb

@@ -5,12 +5,12 @@
 require 'google/protobuf'
 
 
-descriptor_data = "\n\x16secret_detection.proto\x12\x17gitlab.secret_detection\"\xfc\x03\n\x0bScanRequest\x12>\n\x08payloads\x18\x01 \x03(\x0b\x32,.gitlab.secret_detection.ScanRequest.Payload\x12\x19\n\x0ctimeout_secs\x18\x02 \x01(\x02H\x00\x88\x01\x01\x12!\n\x14payload_timeout_secs\x18\x03 \x01(\x02H\x01\x88\x01\x01\x12\x42\n\nexclusions\x18\x04 \x03(\x0b\x32..gitlab.secret_detection.ScanRequest.Exclusion\x12\x0c\n\x04tags\x18\x05 \x03(\t\x1a#\n\x07Payload\x12\n\n\x02id\x18\x01 \x01(\t\x12\x0c\n\x04\x64\x61ta\x18\x02 \x01(\t\x1a\x66\n\tExclusion\x12J\n\x0e\x65xclusion_type\x18\x01 \x01(\x0e\x32\x32.gitlab.secret_detection.ScanRequest.ExclusionType\x12\r\n\x05value\x18\x02 \x01(\t\"f\n\rExclusionType\x12\x1e\n\x1a\x45XCLUSION_TYPE_UNSPECIFIED\x10\x00\x12\x17\n\x13\x45XCLUSION_TYPE_RULE\x10\x01\x12\x1c\n\x18\x45XCLUSION_TYPE_RAW_VALUE\x10\x02\x42\x0f\n\r_timeout_secsB\x17\n\x15_payload_timeout_secs\"\xe2\x03\n\x0cScanResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.gitlab.secret_detection.ScanResponse.Finding\x12\x0e\n\x06status\x18\x02 \x01(\x05\x1a\x9d\x01\n\x07\x46inding\x12\x12\n\npayload_id\x18\x01 \x01(\t\x12\x0e\n\x06status\x18\x02 \x01(\x05\x12\x11\n\x04type\x18\x03 \x01(\tH\x00\x88\x01\x01\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tH\x01\x88\x01\x01\x12\x18\n\x0bline_number\x18\x05 \x01(\x05H\x02\x88\x01\x01\x42\x07\n\x05_typeB\x0e\n\x0c_descriptionB\x0e\n\x0c_line_number\"\xe1\x01\n\x06Status\x12\x16\n\x12STATUS_UNSPECIFIED\x10\x00\x12\x10\n\x0cSTATUS_FOUND\x10\x01\x12\x1c\n\x18STATUS_FOUND_WITH_ERRORS\x10\x02\x12\x17\n\x13STATUS_SCAN_TIMEOUT\x10\x03\x12\x1a\n\x16STATUS_PAYLOAD_TIMEOUT\x10\x04\x12\x15\n\x11STATUS_SCAN_ERROR\x10\x05\x12\x16\n\x12STATUS_INPUT_ERROR\x10\x06\x12\x14\n\x10STATUS_NOT_FOUND\x10\x07\x12\x15\n\x11STATUS_AUTH_ERROR\x10\x08\x32\xc1\x01\n\x07Scanner\x12U\n\x04Scan\x12$.gitlab.secret_detection.ScanRequest\x1a%.gitlab.secret_detection.ScanResponse\"\x00\x12_\n\nScanStream\x12$.gitlab.secret_detection.ScanRequest\x1a%.gitlab.secret_detection.ScanResponse\"\x00(\x01\x30\x01\x42 \xea\x02\x1dGitLab::SecretDetection::GRPCb\x06proto3"
+descriptor_data = "\n\x16secret_detection.proto\x12\x17gitlab.secret_detection\"\xfc\x03\n\x0bScanRequest\x12>\n\x08payloads\x18\x01 \x03(\x0b\x32,.gitlab.secret_detection.ScanRequest.Payload\x12\x19\n\x0ctimeout_secs\x18\x02 \x01(\x02H\x00\x88\x01\x01\x12!\n\x14payload_timeout_secs\x18\x03 \x01(\x02H\x01\x88\x01\x01\x12\x42\n\nexclusions\x18\x04 \x03(\x0b\x32..gitlab.secret_detection.ScanRequest.Exclusion\x12\x0c\n\x04tags\x18\x05 \x03(\t\x1a#\n\x07Payload\x12\n\n\x02id\x18\x01 \x01(\t\x12\x0c\n\x04\x64\x61ta\x18\x02 \x01(\t\x1a\x66\n\tExclusion\x12J\n\x0e\x65xclusion_type\x18\x01 \x01(\x0e\x32\x32.gitlab.secret_detection.ScanRequest.ExclusionType\x12\r\n\x05value\x18\x02 \x01(\t\"f\n\rExclusionType\x12\x1e\n\x1a\x45XCLUSION_TYPE_UNSPECIFIED\x10\x00\x12\x17\n\x13\x45XCLUSION_TYPE_RULE\x10\x01\x12\x1c\n\x18\x45XCLUSION_TYPE_RAW_VALUE\x10\x02\x42\x0f\n\r_timeout_secsB\x17\n\x15_payload_timeout_secs\"\xe2\x03\n\x0cScanResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.gitlab.secret_detection.ScanResponse.Finding\x12\x0e\n\x06status\x18\x02 \x01(\x05\x1a\x9d\x01\n\x07\x46inding\x12\x12\n\npayload_id\x18\x01 \x01(\t\x12\x0e\n\x06status\x18\x02 \x01(\x05\x12\x11\n\x04type\x18\x03 \x01(\tH\x00\x88\x01\x01\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tH\x01\x88\x01\x01\x12\x18\n\x0bline_number\x18\x05 \x01(\x05H\x02\x88\x01\x01\x42\x07\n\x05_typeB\x0e\n\x0c_descriptionB\x0e\n\x0c_line_number\"\xe1\x01\n\x06Status\x12\x16\n\x12STATUS_UNSPECIFIED\x10\x00\x12\x10\n\x0cSTATUS_FOUND\x10\x01\x12\x1c\n\x18STATUS_FOUND_WITH_ERRORS\x10\x02\x12\x17\n\x13STATUS_SCAN_TIMEOUT\x10\x03\x12\x1a\n\x16STATUS_PAYLOAD_TIMEOUT\x10\x04\x12\x15\n\x11STATUS_SCAN_ERROR\x10\x05\x12\x16\n\x12STATUS_INPUT_ERROR\x10\x06\x12\x14\n\x10STATUS_NOT_FOUND\x10\x07\x12\x15\n\x11STATUS_AUTH_ERROR\x10\x08\x32\xc1\x01\n\x07Scanner\x12U\n\x04Scan\x12$.gitlab.secret_detection.ScanRequest\x1a%.gitlab.secret_detection.ScanResponse\"\x00\x12_\n\nScanStream\x12$.gitlab.secret_detection.ScanRequest\x1a%.gitlab.secret_detection.ScanResponse\"\x00(\x01\x30\x01\x42 \xea\x02\x1dGitlab::SecretDetection::GRPCb\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 pool.add_serialized_file(descriptor_data)
 
-module GitLab
+module Gitlab
   module SecretDetection
     module GRPC
       ScanRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("gitlab.secret_detection.ScanRequest").msgclass

data/lib/gitlab/secret_detection/grpc/generated/secret_detection_services_pb.rb

@@ -1,10 +1,10 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
-# Source: secret_detection.proto for package 'GitLab.SecretDetection.GRPC'
+# Source: secret_detection.proto for package 'Gitlab.SecretDetection.GRPC'
 
 require 'grpc'
 require 'secret_detection_pb'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module GRPC
       module Scanner
@@ -18,9 +18,9 @@ module GitLab
           self.service_name = 'gitlab.secret_detection.Scanner'
 
           # Runs secret detection scan for the given request
-          rpc :Scan, ::GitLab::SecretDetection::GRPC::ScanRequest, ::GitLab::SecretDetection::GRPC::ScanResponse
+          rpc :Scan, ::Gitlab::SecretDetection::GRPC::ScanRequest, ::Gitlab::SecretDetection::GRPC::ScanResponse
           # Runs bi-directional streaming of scans for the given stream of requests with a stream of responses
-          rpc :ScanStream, stream(::GitLab::SecretDetection::GRPC::ScanRequest), stream(::GitLab::SecretDetection::GRPC::ScanResponse)
+          rpc :ScanStream, stream(::Gitlab::SecretDetection::GRPC::ScanRequest), stream(::Gitlab::SecretDetection::GRPC::ScanResponse)
         end
 
         Stub = Service.rpc_stub_class

data/lib/gitlab/secret_detection/grpc/scanner_service.rb

@@ -27,7 +27,7 @@ class StreamEnumerator
   end
 end
 
-module GitLab
+module Gitlab
   module SecretDetection
     module GRPC
       class ScannerService < Scanner::Service
@@ -89,21 +89,21 @@ module GitLab
           end
 
           findings = result.results&.map do |finding|
-            GitLab::SecretDetection::GRPC::ScanResponse::Finding.new(**finding.to_h)
+            Gitlab::SecretDetection::GRPC::ScanResponse::Finding.new(**finding.to_h)
           end
 
-          GitLab::SecretDetection::GRPC::ScanResponse.new(
+          Gitlab::SecretDetection::GRPC::ScanResponse.new(
             results: findings,
             status: result.status
           )
         end
 
         def scanner
-          @scanner ||= GitLab::SecretDetection::Core::Scanner.new(rules:, logger:)
+          @scanner ||= Gitlab::SecretDetection::Core::Scanner.new(rules:, logger:)
         end
 
         def rules
-          GitLab::SecretDetection::Core::Ruleset.new.rules
+          Gitlab::SecretDetection::Core::Ruleset.new.rules
         end
 
         # validates grpc request body

data/lib/gitlab/secret_detection/grpc.rb

@@ -4,7 +4,7 @@ require_relative 'grpc/scanner_service'
 require_relative 'grpc/client/stream_request_enumerator'
 require_relative 'grpc/client/grpc_client'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module GRPC
     end

data/lib/gitlab/secret_detection/utils/certificate.rb

@@ -3,11 +3,11 @@
 require 'openssl'
 require_relative 'memoize'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Utils
       module X509
-        # Pulled from GitLab.com source
+        # Pulled from Gitlab.com source
         # Link: https://gitlab.com/gitlab-org/gitlab/-/blob/4713a798f997389f04e442db3d1d8349a39d5d46/lib/gitlab/x509/certificate.rb
         class Certificate
           CERT_REGEX = /-----BEGIN CERTIFICATE-----(?:.|\n)+?-----END CERTIFICATE-----/
@@ -99,7 +99,7 @@ module GitLab
           end
 
           class << self
-            include ::GitLab::SecretDetection::Utils::StrongMemoize
+            include ::Gitlab::SecretDetection::Utils::StrongMemoize
           end
         end
       end

data/lib/gitlab/secret_detection/utils/memoize.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Utils
       # Pulled from GitLab.com source
@@ -16,7 +16,7 @@ module GitLab
         #
         # We could write it like:
         #
-        #     include GitLab::SecretDetection::Utils::StrongMemoize
+        #     include Gitlab::SecretDetection::Utils::StrongMemoize
         #
         #     def trigger_from_token
         #       Ci::Trigger.find_by_token(params[:token].to_s)

data/lib/gitlab/secret_detection/utils.rb

@@ -3,7 +3,7 @@
 require_relative 'utils/certificate'
 require_relative 'utils/memoize'
 
-module GitLab
+module Gitlab
   module SecretDetection
     module Utils
     end

data/lib/gitlab/secret_detection/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module GitLab
+module Gitlab
   module SecretDetection
     class Gem
       DEFAULT_VERSION = "0.0.1"

data/lib/gitlab/secret_detection.rb

@@ -5,7 +5,7 @@ require_relative 'secret_detection/core'
 require_relative 'secret_detection/grpc'
 require_relative 'secret_detection/version'
 
-module GitLab
+module Gitlab
   module SecretDetection
   end
 end

data/lib/gitlab.rb

@@ -2,5 +2,5 @@
 
 require_relative 'gitlab/secret_detection'
 
-module GitLab
+module Gitlab
 end

data/proto/secret_detection.proto

@@ -2,10 +2,10 @@ syntax = "proto3";
 
 package gitlab.secret_detection;
 
-/* We keep generated files within grpc namespace i.e GitLab::SecretDetection::GRPC
+/* We keep generated files within grpc namespace i.e Gitlab::SecretDetection::GRPC
  * so that these files are exported too in the Ruby Gem along with Core and GRPC logic.
  */
-option ruby_package = "GitLab::SecretDetection::GRPC";
+option ruby_package = "Gitlab::SecretDetection::GRPC";
 
 /* Request arg for triggering Scan/ScanStream method */
 message ScanRequest {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-secret_detection
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - group::secret detection
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc