Class: Gem::Guardian::VerificationResult

Inherits:
Data
  • Object
show all
Defined in:
lib/gem/guardian/verifier.rb

Overview

Result object for a single verification attempt.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#actual_sha256 ⇒ String? (readonly)

Returns SHA256 computed from the downloaded .gem artifact.

Returns:

  • (String, nil) —

    SHA256 computed from the downloaded .gem artifact



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#artifact_path ⇒ String? (readonly)

Returns local path to the downloaded artifact.

Returns:

  • (String, nil) —

    local path to the downloaded artifact



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#checksum_source ⇒ Symbol? (readonly)

Returns :lockfile, :registry, or :artifact.

Returns:

  • (Symbol, nil) —

    :lockfile, :registry, or :artifact



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#dependency ⇒ Dependency (readonly)

Returns dependency being verified.

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#error ⇒ Exception? (readonly)

Returns verification error when status is :error.

Returns:

  • (Exception, nil) —

    verification error when status is :error



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#expected_sha256 ⇒ String? (readonly)

Returns independent checksum used as the primary expected digest, or nil when the artifact was only recorded.

Returns:

  • (String, nil) —

    independent checksum used as the primary expected digest, or nil when the artifact was only recorded



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#registry_checksum_provider ⇒ String? (readonly)

Returns checksum provider name, such as rubygems-api, compact-index, or url.

Returns:

  • (String, nil) —

    checksum provider name, such as rubygems-api, compact-index, or url



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#registry_checksum_uri ⇒ String? (readonly)

Returns sanitized URI where the registry or publisher checksum can be inspected.

Returns:

  • (String, nil) —

    sanitized URI where the registry or publisher checksum can be inspected



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#registry_sha256 ⇒ String? (readonly)

Returns registry or publisher checksum used as an optional cross-check.

Returns:

  • (String, nil) —

    registry or publisher checksum used as an optional cross-check



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

#status ⇒ Symbol (readonly)

Returns :ok, :mismatch, or :error.

Returns:

  • (Symbol) —

    :ok, :mismatch, or :error



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/gem/guardian/verifier.rb', line 28

VerificationResult = Data.define(:dependency, :expected_sha256, :actual_sha256, :artifact_path, :status, :error,
                                 :checksum_source, :registry_sha256, :registry_checksum_provider,
                                 :registry_checksum_uri) do
  # Indicates whether the verification result is successful.
  #
  # For +:artifact+ results, success means the artifact digest was recorded,
  # not that an independent checksum comparison occurred.
  #
  # @return [Boolean] +true+ when +status+ is +:ok+
  def ok?
    status == :ok
  end
end

Instance Method Details

#ok? ⇒ Boolean

Indicates whether the verification result is successful.

For :artifact results, success means the artifact digest was recorded, not that an independent checksum comparison occurred.

Returns:

  • (Boolean) —

    true when status is :ok



37
38
39
 
# File 'lib/gem/guardian/verifier.rb', line 37

def ok?
  status == :ok
end