feat: CyberArk Conjur PAM 1.0.0 (#1) (#2)

Co-authored-by: Matthew H. Irby <[email protected]>
Co-authored-by: Keyfactor <[email protected]>

Author: 3 people

.github/workflows/keyfactor-starter-workflow.yml

@@ -0,0 +1,27 @@
+name: Keyfactor Bootstrap Workflow
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [opened, closed, synchronize, edited, reopened]
+  push:
+  create:
+    branches:
+      - 'release-*.*'
+
+jobs:
+  call-starter-workflow:
+    uses: keyfactor/actions/.github/workflows/starter.yml@v4
+    with:
+      command_token_url: ${{ vars.DOCTOOL_COMMAND_TOKEN_URL }}
+      command_hostname: ${{ vars.DOCTOOL_COMMAND_HOSTNAME }}
+      command_base_api_path: ${{ vars.DOCTOOL_COMMAND_BASE_API_PATH}}
+    secrets:
+      token: ${{ secrets.V2BUILDTOKEN}}
+      gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }}
+      gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }}
+      scan_token: ${{ secrets.SAST_TOKEN }}
+      entra_username: ${{ secrets.DOCTOOL_ENTRA_USERNAME }}
+      entra_password: ${{ secrets.DOCTOOL_ENTRA_PASSWD }}
+      command_client_id: ${{ secrets.DOCTOOL_COMMAND_CLIENT_ID }}
+      command_client_secret: ${{ secrets.DOCTOOL_COMMAND_CLIENT_SECRET }}

.github/workflows/pull-request.yml

@@ -0,0 +1,71 @@
+run-name: Build and Test Solution - ${{ github.sha }}
+name: Build and Test Solution
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+    build-and-test-solution:
+      runs-on: ubuntu-latest
+      strategy:
+        matrix:
+            dotnet-version: [ '8.0.x' ]
+      steps:
+        - name: Checkout Code
+          uses: actions/checkout@v4
+
+        - name: Setup .NET 8
+          uses: actions/setup-dotnet@v4
+          with:
+            dotnet-version: '8.0.x'
+        
+        - name: Set up Docker Buildx
+          uses: docker/setup-buildx-action@v3
+
+        - name: Add Keyfactor NuGet Source
+          run: dotnet nuget add source https://nuget.pkg.github.com/Keyfactor/index.json -n github -u ${{ github.actor }} -p ${{ secrets.V2BUILDTOKEN }} --store-password-in-clear-text
+        
+        - name: Restore Dependencies
+          run: dotnet restore
+
+        - name: Build solution
+          run: dotnet build --no-restore --configuration Release
+
+        - name: Run Unit Tests
+          run: dotnet test --configuration Release --no-build --logger "console;verbosity=detailed" --filter "Category!=Integration"
+
+        # load the .env.ci file from the integrations test folder
+        - name: Load .env file
+          uses: xom9ikk/dotenv@v2
+          with:
+            path: ./cyberark-conjur-pam.IntegrationTests
+            mode: ci
+
+        # Pull Docker containers
+        - name: Start Conjur Docker Container
+          run: |
+            docker compose -f quickstart/docker-compose.yml pull
+          env:
+            BUILDKIT_INLINE_CACHE: 1
+
+        - name: Start Conjur Docker Container
+          run: |
+            docker compose -f quickstart/docker-compose.yml up -d
+        
+        # Verify that the API user can authenticate successfully
+        - name: Wait for Conjur API to become ready
+          uses: nick-fields/retry@v2
+          with:
+            timeout_minutes: 1
+            max_attempts: 12
+            retry_wait_seconds: 5
+            command: ./quickstart/scripts/check-user-password.sh 
+
+        - name: Run Integration Tests
+          run: dotnet test --configuration Release --no-build --logger "console;verbosity=detailed" --filter "Category=Integration"
+
+        - name: Stop Conjur Docker Container
+          if: always()
+          run: |
+            docker compose -f quickstart/docker-compose.yml down -v

.gitignore

@@ -348,3 +348,7 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+**/.env.*
+!**/.env.test.example
+!**/.env.ci

CONTRIBUTING.md

@@ -0,0 +1,81 @@
+## Requirements
+- .NET 8 SDK and above
+- Docker (with Docker Compose) - Optional if not using the Quickstart environment
+
+## Unit + Integration Tests
+
+This project features unit and integration tests that can be run from any IDE or command line.
+
+### Setting Up Integration Tests
+
+Inside the `cyberark-conjur-pam.IntegrationTests` directory there is a [.env.test.example](./cyberark-conjur-pam.IntegrationTests/.env.test.example) file with the example environment variables. Copy the file to `.env.test` within the same directory. Fill out the environment variables. Make sure to configure `.env.test` to **always copy** to the output directory (this should already be set within the integration test's .csproj).
+
+You are welcome to fill out the `.env.test` file to set these values to point to an existing CyberArk Conjur environment. Otherwise, these integration tests can also run against the Quickstart environment.
+
+#### Running the Quickstart Environment
+
+> This section can be skipped if you do not plan to run the integration tests against a local Docker environment.
+
+The environment variables for the Quickstart environment are already defined in the `.env.ci` file under the `cyberark-conjur-pam.IntegrationTests` directory. Copy the `.env.ci` file to `.env.test`.
+
+The Quickstart environment hosts a Docker Compose project that builds out a local CyberArk Conjur instance pre-populated with an admin account, a test user account, an example secret variable, and an example policy for the test user account to access the variable. The definition for the Quickstart environment is defined in [the quickstart directory](./quickstart/), which also includes the example policy defined under [the conf/policy](./quickstart/conf/policy) directory.
+
+To run the Quickstart environment, run the following command from the project root:
+
+```bash
+# Use docker-compose if you're on an older Docker version
+docker compose -f ./quickstart/docker-compose.yml up --build
+```
+
+The output of the `conjur-init` container should provide information on how to access the local Conjur instance, including the credentials to use to access the instance.
+
+```bash
+docker logs conjur-init
+
+===========================================
+ConjurUrl: http://localhost:8080 (or your mapped port if different)
+AccountId: testConjurAccount
+
+Admin Login: admin
+Admin API Key: [randomly generated admin api key]
+
+Test User Login: TestUser@local
+Test User Password: Mypassw0rD2!
+Test User API Key: [randomly generated user api key]
+
+Test Variable: local/MyTestVar
+Test Variable Value: MyTestSecretValue123
+===========================================
+```
+
+The secret value for variable `local/MyTestVar` can be accessed by either the admin or the test user, with either their respective API keys or passwords.
+
+The Quickstart environment can be cleaned up with the following command:
+
+```bash
+docker compose -f ./quickstart/docker-compose.yml down -v
+```
+
+### Running the Tests
+
+Here are some command line scripts to run the test suites.
+
+Restore project dependencies (optional):
+```bash
+dotnet restore
+```
+
+Run integration and unit tests:
+```bash
+dotnet test
+```
+
+Run just the unit tests:
+```bash
+dotnet test --filter "Category!=Integration"
+```
+
+Run just the integration tests:
+```bash
+dotnet test --filter "Category=Integration"
+```