Merge branch 'release/1.0.0'

ContinuousSecurityTooling · Oct 14, 2023 · ca3fe53 · ca3fe53
2 parents 0307a9a + 3428c94
commit ca3fe53
Show file tree

Hide file tree

Showing 26 changed files with 583 additions and 166 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,43 @@
+# [1.0.0](https://github.com/ContinuousSecurityTooling/keycloak-auditor/compare/v0.5.0...v1.0.0) (2023-10-14)
+
+
+### Bug Fixes
+
+* Correcting ts generator output ([4bbf8b9](https://github.com/ContinuousSecurityTooling/keycloak-auditor/commit/4bbf8b9ebeff7dc81f4929f578751025afe45c12))
+
+
+### Features
+
+* **Master Access:** Allow fetching of all users/clients from master realm ([a344096](https://github.com/ContinuousSecurityTooling/keycloak-auditor/commit/a3440961c5a5241eee7807fec436758df08d6ff6))
+* **SDK:** Fix SDK setup ([70481a6](https://github.com/ContinuousSecurityTooling/keycloak-auditor/commit/70481a6da40877dcc1c09c6d3a5d6017e83fa82c))
+
+
+### BREAKING CHANGES
+
+* **Master Access:** To enable this feature set env var `KC_AUD_GLOBAL_MASTER_ACCESS` to `true`
+
+
+
+## [0.5.1-SNAPSHOT](https://github.com/ContinuousSecurityTooling/keycloak-auditor/compare/v0.5.0...v0.5.1-SNAPSHOT) (2023-10-14)
+
+
+### Bug Fixes
+
+* Correcting ts generator output ([4bbf8b9](https://github.com/ContinuousSecurityTooling/keycloak-auditor/commit/4bbf8b9ebeff7dc81f4929f578751025afe45c12))
+
+
+### Features
+
+* **Master Access:** Allow fetching of all users/clients from master realm ([a344096](https://github.com/ContinuousSecurityTooling/keycloak-auditor/commit/a3440961c5a5241eee7807fec436758df08d6ff6))
+* **SDK:** Fix SDK setup ([70481a6](https://github.com/ContinuousSecurityTooling/keycloak-auditor/commit/70481a6da40877dcc1c09c6d3a5d6017e83fa82c))
+
+
+### BREAKING CHANGES
+
+* **Master Access:** To enable this feature set env var `KC_AUD_GLOBAL_MASTER_ACCESS` to `true`
+
+
+
 # [0.5.0](https://github.com/ContinuousSecurityTooling/keycloak-auditor/compare/v0.4.1...v0.5.0) (2023-10-10)
 
 

diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 [![CI](https://github.com/ContinuousSecurityTooling/keycloak-auditor/actions/workflows/build.yml/badge.svg)](https://github.com/ContinuousSecurityTooling/keycloak-auditor/actions/workflows/build.yml)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ContinuousSecurityTooling_keycloak-auditor&metric=alert_status)](https://sonarcloud.io/dashboard?id=ContinuousSecurityTooling_keycloak-auditor)
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ContinuousSecurityTooling_keycloak-auditor&metric=coverage)](https://sonarcloud.io/dashboard?id=ContinuousSecurityTooling_keycloak-auditor)
+[![npm version](https://badge.fury.io/js/@continuoussecuritytooling%2Fkeycloak-auditor.svg)](https://www.npmjs.com/package/@continuoussecuritytooling/keycloak-auditor)
 [![Known Vulnerabilities](https://snyk.io/test/github/ContinuousSecurityTooling/keycloak-auditor/badge.svg)](https://snyk.io/test/github/ContinuousSecurityTooling/keycloak-auditor)
 
 # Keycloak Auditor
@@ -96,6 +97,7 @@ For Keycloak Legacy (<=19) Use the EAR from [0.3.1](https://github.com/Continuou
 
 ## Configuration
 
-* `AUD_DISABLE_EXTERNAL_ACCESS` - To disable API being externally accessible to a cluster. Set the environment variable 'AUD_DISABLE_EXTERNAL_ACCESS'. Once set enable the header 'X-Forwarded-Host' on your proxy. This is enabled by default on HA Proxy on Openshift.
+* `AUD_DISABLE_EXTERNAL_ACCESS` - To disable API being externally accessible to a cluster. Set the environment variable 'AUD_DISABLE_EXTERNAL_ACCESS'. Once set enable the header 'X-Forwarded-Host' on your proxy. This is enabled by default on HA Proxy on Openshift. Defaults to `false`
 * `KC_AUD_DISABLE_ROLE_CHECK` - To disable realm access check set value to `true`. Defaults to `false`
-* `KC_AUD_DEFAULT_ROLE` - Set the role the client needs to have. Defaults to `admin`
+* `KC_AUD_DEFAULT_ROLE` - Set the role the client needs to have. Defaults to `admin`
+* `KC_AUD_GLOBAL_MASTER_ACCESS` - Enable client in master account to iterate to over realms, Default o `false.
diff --git a/deployment/pom.xml b/deployment/pom.xml
@@ -4,7 +4,7 @@
  <parent>
  <groupId>net.continuous-security-tools</groupId>
  <artifactId>keycloak-auditor</artifactId>
- <version>0.5.0</version>
+ <version>1.0.0</version>
  </parent>
 
  <artifactId>deployment</artifactId>

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -45,6 +45,7 @@ services:
  KC_DB_PASSWORD: ${MYSQL_PASSWORD}
  KEYCLOAK_ADMIN: 'admin'
  KEYCLOAK_ADMIN_PASSWORD: 'admin'
+ KC_AUD_GLOBAL_MASTER_ACCESS: 'true'
 
  maildev:
  container_name: maildev

diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
  <groupId>net.continuous-security-tools</groupId>
  <artifactId>keycloak-auditor</artifactId>
- <version>0.5.0</version>
+ <version>1.0.0</version>
  <name>Auditing Tooling for Keycloak Server</name>
  <packaging>pom</packaging>
 
@@ -65,7 +65,7 @@
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <project.build.resourceEncoding>UTF-8</project.build.resourceEncoding>
  <encoding>UTF-8</encoding>
- <surefireArgLine></surefireArgLine>
+ <surefire.argLine/>
 
  <java.version>17</java.version>
 
@@ -243,6 +243,12 @@
  <groupId>org.mockito</groupId>
  <artifactId>mockito-junit-jupiter</artifactId>
  </dependency>
+ <dependency>
+ <groupId>org.junit-pioneer</groupId>
+ <artifactId>junit-pioneer</artifactId>
+ <version>2.1.0</version>
+ <scope>test</scope>
+ </dependency>
  </dependencies>
 
  <build>
@@ -262,6 +268,13 @@
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-surefire-plugin</artifactId>
  <version>${maven-surefire-plugin.version}</version>
+ <configuration>
+ <threadCount>1</threadCount>
+ <perCoreThreadCount>false</perCoreThreadCount>
+ <argLine>
+ @{surefire.argLine} --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.lang=ALL-UNNAMED
+ </argLine>
+ </configuration>
  </plugin>
 
  <plugin>
@@ -309,6 +322,9 @@
  <goals>
  <goal>prepare-agent</goal>
  </goals>
+ <configuration>
+ <propertyName>surefire.argLine</propertyName>
+ </configuration>
  </execution>
  <!-- attached to Maven test phase -->
  <execution>
@@ -317,6 +333,9 @@
  <goals>
  <goal>report</goal>
  </goals>
+ <configuration>
+ <outputDirectory>${project.reporting.outputDirectory}/jacoco</outputDirectory>
+ </configuration>
  </execution>
  </executions>
  </plugin>

diff --git a/sdk/.npmignore b/sdk/.npmignore
@@ -0,0 +1,2 @@
+node_modules
+tmp
diff --git a/sdk/README.md b/sdk/README.md
@@ -0,0 +1,8 @@
+# Keycloak Auditor SDK
+
+Typings for [Keycloak Auditor](https://github.com/ContinuousSecurityTooling/keycloak-auditor) SPI Rest Endpoint:
+
+```
+import { ClientLoginDetails } from '@continuoussecuritytooling/keycloak-auditor';
+
+```
diff --git a/sdk/index.ts b/sdk/index.ts
@@ -1,5 +1,6 @@
 export {
  Constants,
+ ConfigConstants,
  ClientLoginDetails,
  UserLoginDetails,
-} from '../spi/target/typescript-generator/spi.ts';
+} from './src/spi.ts';