Merge pull request #68 from mgbcaio/opensource-guidelines

GOVERNANCE.md

@@ -2,7 +2,9 @@
 
 ### Users
 
-These are individuals who 1) want to learn more about the Galadriel Project; or 2) are existing users of Galadriel and its tools who wish to follow the Project's progress.
+These are individuals who 
+- 1) Want to learn more about the Galadriel Project; 
+- 2) Are existing users of Galadriel and its tools who wish to follow the Project's progress.
 
 ### Contributors
 

LICENSE.md

@@ -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 2022 Hewlett Packard Enterprise
+
+   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.

README.md

@@ -5,7 +5,5 @@
 [![Scorecards supply-chain security](https://github.com/HewlettPackard/galadriel/actions/workflows/scorecards.yml/badge.svg)](https://github.com/HewlettPackard/galadriel/actions/workflows/scorecards.yml)
 [![trivy](https://github.com/HewlettPackard/galadriel/actions/workflows/trivy.yml/badge.svg)](https://github.com/HewlettPackard/galadriel/actions/workflows/trivy.yml)
 
-<span style="color:blue;font-size:40px">
-    NOTE: A PoC is under development.
-</span>
-
+- [PoC Instructions](./doc/INSTRUCTIONS.md)
+- [Usage Instructions](./doc/USAGE.md)

SECURITY.md

@@ -0,0 +1,16 @@
+# Security Policy
+
+## Supported Versions
+
+Versions of the project that are currently being supported with security updates:
+
+| Version | Supported |
+|--|--|
+| <=0.1.x | ✅ |
+
+
+## Reporting a Vulnerability
+
+If you've found a vulnerability or a potential vulnerability in Galadriel please reach out to any of the maintainers using any private communication channel at your discretion.
+
+The maintainers are currently available at the [SPIFFE Slack](https://slack.spiffe.io).

conf/harvester/harvester.conf

@@ -12,7 +12,7 @@ harvester {
     # Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". 
     # Default: 30s
     # E.g: 12h, 5m, 90000ms
-    bundle_updates_interval = "5s"
+    bundle_updates_interval = "30s"
 
     # log_level: Application log level. One of: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, PANIC
     # Default: INFO

doc/INSTRUCTIONS.md

@@ -0,0 +1,58 @@
+# Instructions
+Below is a list of instructions for running the PoC application.
+
+## Requirements
+In order to run Galadriel you should have:
+- [Go Lang](https://go.dev/dl/) installed at version `1.19.x`
+- A running [SPIRE](https://spiffe.io/docs/latest/deploying/install-server/) server
+
+## Running the PoC locally
+In order to run the PoC locally, clone the repository:
+```bash
+git clone https://github.com/HewlettPackard/galadriel.git && cd galadriel
+```
+
+After cloning the repository you will be able to build the application:
+```bash
+make build
+```
+
+With the built application you can use the binaries in the `bin` directory to run the Galadriel Server and Harvester:
+
+## Configuring the Galadriel Server and Harvester
+Before continuing make sure you have configured the Galadriel [Server](./USAGE.md#galadriel-server-configuration-file) and [Harvester](./USAGE.md#galadriel-harvester-configuration-file) with the appropriate configuration for your environment.
+
+## Galadriel Server
+To start the Galadriel Server you can use:
+```bash
+bin/galadriel-server run
+```
+
+You should see something like this in your terminal, indicating that the Galadriel Server is now `running`
+```bash
+INFO[0000] Starting TCP Server on 127.0.0.1:8085         subsystem_name=endpoints
+INFO[0000] Starting UDS Server on /tmp/galadriel-server/api.sock  subsystem_name=endpoints
+```
+
+With the Galadriel Server running you will need to register a new Galadriel Harvester `Member`:
+```bash
+bin/galadriel-server create member -t <your SPIRE Trust Domain>
+```
+
+After registering the `Member` you will need to generate a new token to onboard the Galadriel Harvester that will manage the SPIRE Server:
+```bash
+ACCESS_TOKEN=$(bin/galadriel-server generate token -t <your SPIRE Trust Domain> | cut -d ' ' -f 3)
+```
+## Galadriel Harvester
+To start the Galadriel Harvester you can execute the following command, using the `Access Token` generated from the Galadriel Server:
+
+```bash
+bin/galadriel-harvester run -t $ACCESS_TOKEN
+```
+
+This will result in the following output:
+```bash
+INFO[0000] Starting Harvester                            subsystem_name=harvester
+INFO[0000] Connected to Galadriel Server                 subsystem_name=galadriel_server_client
+INFO[0000] Starting harvester controller                 subsystem_name=harvester_controller
+```

doc/USAGE.md

@@ -0,0 +1,55 @@
+# Galadriel Server CLI
+The Galadriel Server CLI contains the functionality to:
+### `galadriel-server create member`
+| Flag | Type | Required | Description |
+|--|--|--|--|
+| `-t`, `--trustDomain`| string | Yes | SPIRE server trust domain |
+
+
+### `galadriel-server create relationship`
+| Flag | Type | Required | Description |
+|--|--|--|--|
+| `-a`, `--trustDomainA` | string | Yes | SPIRE Server trust domain A |
+| `-b`, `--trustDomainB` | string | Yes | SPIRE Server trust domain B |
+
+
+### `galadriel-server generate token`
+| Flag | Type | Required | Description |
+|--|--|--|--|
+| `-t`, `--trustDomain` | string | Yes | SPIRE server trust domain |
+
+
+### `galadriel-server list`
+| Command | Description |
+|--|--|
+| `members` | List all members stored in the Galadriel Server |
+| `relationships` | List all relationships stored in the Galadriel Server |
+
+# Galadriel Harvester CLI
+The Galadriel Harvester CLI contains the functionality to run the Galadriel Harvester while attaching it to the Galadriel Server instance, based on the token used as a argument:
+
+### `galadriel-harvester run`
+| Flag | Type | Required | Description |
+|--|--|--|--|
+| `-t`, `--token` | string | Yes | Token generated by the Galadriel Server for this trust domain |
+| `-c`, `--config` | string |  | Config file path. If not set uses the default value: `conf/harvester/harvester.conf` |
+
+# Galadriel Server Configuration File
+You can find the default Galadriel Server configuration file at `conf/server/server.conf`
+
+| Configuration | Description | Default |
+|--|--|--|
+| `listen_address` | IP address or DNS name of the Galadriel server. | localhost |
+| `listen_port` | HTTP Port number of the Galadriel server. | 8085 |
+| `socket_path` | Path to bind the Galadriel Server API socket to. | /tmp/galadriel-server/api.sock |
+| `log_level` | Application log level. One of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, `PANIC` | INFO |
+
+# Galadriel Harvester Configuration File
+You can find the default Galadriel Harvester configuration file at `conf/harvester/harvester.conf`
+
+| Configuration | Description | Required | Default
+|--|--|--|--|
+| `spire_socket_path` | SPIRE Server Socket of the instance to manage. | | /tmp/spire-server/private/api.sock |
+| `server_address` | Upstream Galadriel Server DNS name or IP address with port. | Yes | |
+| `bundle_updates_interval` | Sets how often to check for bundle rotation. | | 30s |
+| `log_level` | Application log level. One of: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, `PANIC` | | INFO |