Add provider_permissions field for declaring integration permission requirements

code/go/pkg/validator/validator_test.go

@@ -66,6 +66,8 @@ func TestValidateFile(t *testing.T) {
 		"logs_synthetic_mode":                    {},
 		"kibana_configuration_links":             {},
 		"with_links":                             {},
+		"good_provider_permissions":              {},
+		"good_provider_permissions_input":        {},
 		"bad_duration_vars": {
 			"manifest.yml",
 			[]string{
@@ -246,6 +248,24 @@ func TestValidateFile(t *testing.T) {
 				"\"Dashboard with mixed by-value visualizations\" contains legacy visualization: \"Timelion time series\" (timelion, Timelion)",
 			},
 		},
+		"bad_provider_permissions": {
+			"manifest.yml",
+			[]string{
+				`field provider_permissions.0: provider is required`,
+			},
+		},
+		"bad_provider_permissions_missing_name": {
+			"manifest.yml",
+			[]string{
+				`field provider_permissions.0.permissions.0: name is required`,
+			},
+		},
+		"bad_provider_permissions_extra_field": {
+			"manifest.yml",
+			[]string{
+				`field provider_permissions.0.permissions.0: Additional property resources is not allowed`,
+			},
+		},
 		"bad_deployment_mode": {
 			"manifest.yml",
 			[]string{

spec/changelog.yml

@@ -8,6 +8,11 @@
     - description: Add support for semantic_text field definition.
       type: enhancement
       link: https://github.com/elastic/package-spec/pull/807
+- version: 3.6.4
+  changes:
+    - description: Add provider_permissions field to package, policy_template, input, and data_stream levels for declaring provider-specific permissions.
+      type: enhancement
+      link: https://github.com/elastic/package-spec/pull/1180
 - version: 3.6.3
   changes:
     - description: Add optional `release` field to agentless deployment mode to explicitly declare its release stage.

spec/input/manifest.spec.yml

@@ -84,6 +84,8 @@ spec:
             $ref: "../integration/manifest.spec.yml#/definitions/var_groups"
           sections:
             $ref: "../integration/manifest.spec.yml#/definitions/sections"
+          provider_permissions:
+            $ref: "../integration/manifest.spec.yml#/definitions/provider_permissions"
           input:
             type: string
             examples:
@@ -146,6 +148,8 @@ spec:
       $ref: "../integration/manifest.spec.yml#/definitions/var_groups"
     sections:
       $ref: "../integration/manifest.spec.yml#/definitions/sections"
+    provider_permissions:
+      $ref: "../integration/manifest.spec.yml#/definitions/provider_permissions"
     owner:
       $ref: "../integration/manifest.spec.yml#/definitions/owner"
     agent:

spec/integration/data_stream/manifest.spec.yml

@@ -706,6 +706,8 @@ spec:
       $ref: "../../integration/manifest.spec.yml#/definitions/categories"
     deprecated:
       $ref: "../../integration/manifest.spec.yml#/definitions/deprecated"
+    provider_permissions:
+      $ref: "../../integration/manifest.spec.yml#/definitions/provider_permissions"
   required:
   - title
 # JSON patches for newer versions should be placed on top

spec/integration/manifest.spec.yml

@@ -736,6 +736,84 @@ spec:
       type: string
       examples:
         - httpjson
+    provider_permissions:
+      description: >
+        Permissions and roles this integration unit requires from the named provider.
+        May be declared at package, policy_template, input, and data_stream levels;
+        entries across all applicable levels are accumulated into a single set and deduplicated.
+      type: array
+      items:
+        type: object
+        additionalProperties: false
+        required:
+          - provider
+        properties:
+          provider:
+            description: Identifier of the provider these permissions apply to.
+            type: string
+            examples:
+              - aws
+              - gcp
+              - azure
+              - kubernetes
+              - okta
+              - github
+          description:
+            description: Human-readable description of why these permissions are needed.
+            type: string
+          roles:
+            description: Pre-defined roles or managed policies to attach alongside inline permissions.
+            type: array
+            items:
+              type: object
+              additionalProperties: false
+              required:
+                - name
+              properties:
+                name:
+                  description: Display name of the role or managed policy.
+                  type: string
+                  examples:
+                    - SecurityAudit
+                    - Storage Blob Data Reader
+                    - roles/logging.viewer
+                    - cluster-reader
+                id:
+                  description: Provider-specific identifier for this role or managed policy.
+                  type: string
+                  examples:
+                    - arn:aws:iam::aws:policy/SecurityAudit
+                    - roles/storage.objectViewer
+                    - 2a2b9908-6ea1-4ae2-8e65-a410df84e7d1
+                description:
+                  description: Human-readable description of this role.
+                  type: string
+          permissions:
+            description: Individual permission grants required by this integration unit.
+            type: array
+            items:
+              type: object
+              additionalProperties: false
+              required:
+                - name
+              properties:
+                name:
+                  description: Provider-specific permission or action name.
+                  type: string
+                  examples:
+                    - s3:GetObject
+                    - ec2:DescribeInstances
+                    - storage.objects.get
+                    - monitoring.timeSeries.list
+                    - Microsoft.Compute/virtualMachines/read
+                    - Microsoft.Insights/metrics/read
+                    - pods:list
+                    - namespaces:get
+                    - okta.users.read
+                    - contents:read
+                description:
+                  description: Human-readable description of why this permission is needed.
+                  type: string
   properties:
     format_version:
       description: The version of the package specification format used by this package.
@@ -766,6 +844,8 @@ spec:
       $ref: "#/definitions/categories"
     conditions:
       $ref: "#/definitions/conditions"
+    provider_permissions:
+      $ref: "#/definitions/provider_permissions"
     # requires a conditional JSON schema to update the value depending
     # on the policy_templates length
     policy_templates_behavior:
@@ -903,6 +983,8 @@ spec:
                       type: string
                   examples:
                     - credential_type: [cloud_connectors]
+                provider_permissions:
+                  $ref: "#/definitions/provider_permissions"
               required:
                 - title
                 - description
@@ -923,6 +1005,8 @@ spec:
             $ref: "#/definitions/sections"
           deprecated:
             $ref: "#/definitions/deprecated"
+          provider_permissions:
+            $ref: "#/definitions/provider_permissions"
         required:
           - name
           - title

test/packages/bad_provider_permissions/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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
+
+       http://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.

test/packages/bad_provider_permissions/changelog.yml

@@ -0,0 +1,6 @@
+# newer versions go on top
+- version: "0.0.1"
+  changes:
+    - description: Initial draft of the package
+      type: enhancement
+      link: https://github.com/elastic/integrations/pull/1

test/packages/bad_provider_permissions/docs/README.md

@@ -0,0 +1,3 @@
+# Bad Provider Permissions
+
+Test package for rejecting `provider_permissions` with missing required `provider` field.