grafeas 0.0.1 → 0.1.0

data/lib/grafeas/v1/doc/google/protobuf/timestamp.rb

@@ -0,0 +1,113 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Protobuf
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+    # restricting to that range, we ensure that we can convert to and from [RFC
+    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
+    #
+    # = Examples
+    #
+    # Example 1: Compute Timestamp from POSIX `time()`.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    #
+    # Example 5: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Timestamp type is encoded as a string in the
+    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
+    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
+    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
+    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
+    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
+    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
+    # is required. A proto3 JSON serializer should always use UTC (as indicated by
+    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
+    # able to accept both UTC and other timezones (as indicated by an offset).
+    #
+    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
+    # 01:30 UTC on January 15, 2017.
+    #
+    # In JavaScript, one can convert a Date object to this format using the
+    # standard
+    # [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
+    # method. In Python, a standard `datetime.datetime` object can be converted
+    # to this format using
+    # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
+    # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
+    # the Joda Time's [`ISODateTimeFormat.dateTime()`](
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
+    # ) to obtain a formatter capable of generating timestamps in this format.
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp; end
+  end
+end

data/lib/grafeas/v1/doc/google/rpc/status.rb

@@ -0,0 +1,87 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Google
+  module Rpc
+    # The `Status` type defines a logical error model that is suitable for
+    # different programming environments, including REST APIs and RPC APIs. It is
+    # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+    #
+    # * Simple to use and understand for most users
+    # * Flexible enough to meet unexpected needs
+    #
+    # = Overview
+    #
+    # The `Status` message contains three pieces of data: error code, error
+    # message, and error details. The error code should be an enum value of
+    # {Google::Rpc::Code}, but it may accept additional error codes
+    # if needed.  The error message should be a developer-facing English message
+    # that helps developers *understand* and *resolve* the error. If a localized
+    # user-facing error message is needed, put the localized message in the error
+    # details or localize it in the client. The optional error details may contain
+    # arbitrary information about the error. There is a predefined set of error
+    # detail types in the package `google.rpc` that can be used for common error
+    # conditions.
+    #
+    # = Language mapping
+    #
+    # The `Status` message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the `Status` message is
+    # exposed in different client libraries and different wire protocols, it can be
+    # mapped differently. For example, it will likely be mapped to some exceptions
+    # in Java, but more likely mapped to some error codes in C.
+    #
+    # = Other uses
+    #
+    # The error model and the `Status` message can be used in a variety of
+    # environments, either with or without APIs, to provide a
+    # consistent developer experience across different environments.
+    #
+    # Example uses of this error model include:
+    #
+    # * Partial errors. If a service needs to return partial errors to the client,
+    #   it may embed the `Status` in the normal response to indicate the partial
+    #   errors.
+    #
+    # * Workflow errors. A typical workflow has multiple steps. Each step may
+    #   have a `Status` message for error reporting.
+    #
+    # * Batch operations. If a client uses batch request and batch response, the
+    #   `Status` message should be used directly inside batch response, one for
+    #   each error sub-response.
+    #
+    # * Asynchronous operations. If an API call embeds asynchronous operation
+    #   results in its response, the status of those operations should be
+    #   represented directly using the `Status` message.
+    #
+    # * Logging. If some API errors are stored in logs, the message `Status` could
+    #   be used directly after any stripping needed for security/privacy reasons.
+    # @!attribute [rw] code
+    #   @return [Integer]
+    #     The status code, which should be an enum value of
+    #     {Google::Rpc::Code}.
+    # @!attribute [rw] message
+    #   @return [String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     {Google::Rpc::Status#details} field, or localized
+    #     by the client.
+    # @!attribute [rw] details
+    #   @return [Array<Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
+    class Status; end
+  end
+end

data/lib/grafeas/v1/doc/grafeas/v1/attestation.rb

@@ -0,0 +1,64 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Grafeas
+  module V1
+    # Note kind that represents a logical attestation "role" or "authority". For
+    # example, an organization might have one `Authority` for "QA" and one for
+    # "build". This note is intended to act strictly as a grouping mechanism for
+    # the attached occurrences (Attestations). This grouping mechanism also
+    # provides a security boundary, since IAM ACLs gate the ability for a principle
+    # to attach an occurrence to a given note. It also provides a single point of
+    # lookup to find all attached attestation occurrences, even if they don't all
+    # live in the same project.
+    # @!attribute [rw] hint
+    #   @return [Grafeas::V1::AttestationNote::Hint]
+    #     Hint hints at the purpose of the attestation authority.
+    class AttestationNote
+      # This submessage provides human-readable hints about the purpose of the
+      # authority. Because the name of a note acts as its resource reference, it is
+      # important to disambiguate the canonical name of the Note (which might be a
+      # UUID for security purposes) from "readable" names more suitable for debug
+      # output. Note that these hints should not be used to look up authorities in
+      # security sensitive contexts, such as when looking up attestations to
+      # verify.
+      # @!attribute [rw] human_readable_name
+      #   @return [String]
+      #     Required. The human readable name of this attestation authority, for
+      #     example "qa".
+      class Hint; end
+    end
+
+    # Occurrence that represents a single "attestation". The authenticity of an
+    # attestation can be verified using the attached signature. If the verifier
+    # trusts the public key of the signer, then verifying the signature is
+    # sufficient to establish trust. In this circumstance, the authority to which
+    # this attestation is attached is primarily useful for lookup (how to find
+    # this attestation if you already know the authority and artifact to be
+    # verified) and intent (for which authority this attestation was intended to
+    # sign.
+    # @!attribute [rw] serialized_payload
+    #   @return [String]
+    #     Required. The serialized payload that is verified by one or more
+    #     `signatures`.
+    # @!attribute [rw] signatures
+    #   @return [Array<Grafeas::V1::Signature>]
+    #     One or more signatures over `serialized_payload`.  Verifier implementations
+    #     should consider this attestation message verified if at least one
+    #     `signature` verifies `serialized_payload`.  See `Signature` in common.proto
+    #     for more details on signature structure and verification.
+    class AttestationOccurrence; end
+  end
+end

data/lib/grafeas/v1/doc/grafeas/v1/build.rb

@@ -0,0 +1,44 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Grafeas
+  module V1
+    # Note holding the version of the provider's builder and the signature of the
+    # provenance message in the build details occurrence.
+    # @!attribute [rw] builder_version
+    #   @return [String]
+    #     Required. Immutable. Version of the builder which produced this build.
+    class BuildNote; end
+
+    # Details of a build occurrence.
+    # @!attribute [rw] provenance
+    #   @return [Grafeas::V1::BuildProvenance]
+    #     Required. The actual provenance for the build.
+    # @!attribute [rw] provenance_bytes
+    #   @return [String]
+    #     Serialized JSON representation of the provenance, used in generating the
+    #     build signature in the corresponding build note. After verifying the
+    #     signature, `provenance_bytes` can be unmarshalled and compared to the
+    #     provenance to confirm that it is unchanged. A base64-encoded string
+    #     representation of the provenance bytes is used for the signature in order
+    #     to interoperate with openssl which expects this format for signature
+    #     verification.
+    #
+    #     The serialized form is captured both to avoid ambiguity in how the
+    #     provenance is marshalled to json as well to prevent incompatibilities with
+    #     future changes.
+    class BuildOccurrence; end
+  end
+end

data/lib/grafeas/v1/doc/grafeas/v1/common.rb

@@ -0,0 +1,105 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Grafeas
+  module V1
+    # Metadata for any related URL information.
+    # @!attribute [rw] url
+    #   @return [String]
+    #     Specific URL associated with the resource.
+    # @!attribute [rw] label
+    #   @return [String]
+    #     Label to describe usage of the URL.
+    class RelatedUrl; end
+
+    # Verifiers (e.g. Kritis implementations) MUST verify signatures
+    # with respect to the trust anchors defined in policy (e.g. a Kritis policy).
+    # Typically this means that the verifier has been configured with a map from
+    # `public_key_id` to public key material (and any required parameters, e.g.
+    # signing algorithm).
+    #
+    # In particular, verification implementations MUST NOT treat the signature
+    # `public_key_id` as anything more than a key lookup hint. The `public_key_id`
+    # DOES NOT validate or authenticate a public key; it only provides a mechanism
+    # for quickly selecting a public key ALREADY CONFIGURED on the verifier through
+    # a trusted channel. Verification implementations MUST reject signatures in any
+    # of the following circumstances:
+    # * The `public_key_id` is not recognized by the verifier.
+    #   * The public key that `public_key_id` refers to does not verify the
+    #     signature with respect to the payload.
+    #
+    #   The `signature` contents SHOULD NOT be "attached" (where the payload is
+    #   included with the serialized `signature` bytes). Verifiers MUST ignore any
+    #   "attached" payload and only verify signatures with respect to explicitly
+    #   provided payload (e.g. a `payload` field on the proto message that holds
+    #   this Signature, or the canonical serialization of the proto message that
+    #   holds this signature).
+    # @!attribute [rw] signature
+    #   @return [String]
+    #     The content of the signature, an opaque bytestring.
+    #     The payload that this signature verifies MUST be unambiguously provided
+    #     with the Signature during verification. A wrapper message might provide
+    #     the payload explicitly. Alternatively, a message might have a canonical
+    #     serialization that can always be unambiguously computed to derive the
+    #     payload.
+    # @!attribute [rw] public_key_id
+    #   @return [String]
+    #     The identifier for the public key that verifies this signature.
+    #     * The `public_key_id` is required.
+    #       * The `public_key_id` MUST be an RFC3986 conformant URI.
+    #       * When possible, the `public_key_id` SHOULD be an immutable reference,
+    #         such as a cryptographic digest.
+    #
+    #       Examples of valid `public_key_id`s:
+    #
+    #     OpenPGP V4 public key fingerprint:
+    #     * "openpgp4fpr:74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA"
+    #       See https://www.iana.org/assignments/uri-schemes/prov/openpgp4fpr for more
+    #       details on this scheme.
+    #
+    #     RFC6920 digest-named SubjectPublicKeyInfo (digest of the DER
+    #     serialization):
+    #     * "ni:///sha-256;cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU"
+    #       * "nih:///sha-256;703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
+    class Signature; end
+
+    # Kind represents the kinds of notes supported.
+    module NoteKind
+      # Unknown.
+      NOTE_KIND_UNSPECIFIED = 0
+
+      # The note and occurrence represent a package vulnerability.
+      VULNERABILITY = 1
+
+      # The note and occurrence assert build provenance.
+      BUILD = 2
+
+      # This represents an image basis relationship.
+      IMAGE = 3
+
+      # This represents a package installed via a package manager.
+      PACKAGE = 4
+
+      # The note and occurrence track deployment events.
+      DEPLOYMENT = 5
+
+      # The note and occurrence track the initial discovery status of a resource.
+      DISCOVERY = 6
+
+      # This represents a logical "role" that can attest to artifacts.
+      ATTESTATION = 7
+    end
+  end
+end

data/lib/grafeas/v1/doc/grafeas/v1/cvss.rb

@@ -0,0 +1,104 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+module Grafeas
+  module V1
+    # Common Vulnerability Scoring System version 3.
+    # For details, see https://www.first.org/cvss/specification-document
+    # @!attribute [rw] base_score
+    #   @return [Float]
+    #     The base score is a function of the base metric scores.
+    # @!attribute [rw] exploitability_score
+    #   @return [Float]
+    # @!attribute [rw] impact_score
+    #   @return [Float]
+    # @!attribute [rw] attack_vector
+    #   @return [Grafeas::V1::CVSSv3::AttackVector]
+    #     Base Metrics
+    #     Represents the intrinsic characteristics of a vulnerability that are
+    #     constant over time and across user environments.
+    # @!attribute [rw] attack_complexity
+    #   @return [Grafeas::V1::CVSSv3::AttackComplexity]
+    # @!attribute [rw] privileges_required
+    #   @return [Grafeas::V1::CVSSv3::PrivilegesRequired]
+    # @!attribute [rw] user_interaction
+    #   @return [Grafeas::V1::CVSSv3::UserInteraction]
+    # @!attribute [rw] scope
+    #   @return [Grafeas::V1::CVSSv3::Scope]
+    # @!attribute [rw] confidentiality_impact
+    #   @return [Grafeas::V1::CVSSv3::Impact]
+    # @!attribute [rw] integrity_impact
+    #   @return [Grafeas::V1::CVSSv3::Impact]
+    # @!attribute [rw] availability_impact
+    #   @return [Grafeas::V1::CVSSv3::Impact]
+    class CVSSv3
+      module AttackComplexity
+        ATTACK_COMPLEXITY_UNSPECIFIED = 0
+
+        ATTACK_COMPLEXITY_LOW = 1
+
+        ATTACK_COMPLEXITY_HIGH = 2
+      end
+
+      module AttackVector
+        ATTACK_VECTOR_UNSPECIFIED = 0
+
+        ATTACK_VECTOR_NETWORK = 1
+
+        ATTACK_VECTOR_ADJACENT = 2
+
+        ATTACK_VECTOR_LOCAL = 3
+
+        ATTACK_VECTOR_PHYSICAL = 4
+      end
+
+      module Impact
+        IMPACT_UNSPECIFIED = 0
+
+        IMPACT_HIGH = 1
+
+        IMPACT_LOW = 2
+
+        IMPACT_NONE = 3
+      end
+
+      module PrivilegesRequired
+        PRIVILEGES_REQUIRED_UNSPECIFIED = 0
+
+        PRIVILEGES_REQUIRED_NONE = 1
+
+        PRIVILEGES_REQUIRED_LOW = 2
+
+        PRIVILEGES_REQUIRED_HIGH = 3
+      end
+
+      module Scope
+        SCOPE_UNSPECIFIED = 0
+
+        SCOPE_UNCHANGED = 1
+
+        SCOPE_CHANGED = 2
+      end
+
+      module UserInteraction
+        USER_INTERACTION_UNSPECIFIED = 0
+
+        USER_INTERACTION_NONE = 1
+
+        USER_INTERACTION_REQUIRED = 2
+      end
+    end
+  end
+end