Skip to content

Commit f9bca86

Browse files
CDR-FarooqKCDR-CI
andauthored
v1.1.1 release (#16)
Co-authored-by: CDR Open Source <opensource@cdr.gov.au>
1 parent 7365932 commit f9bca86

File tree

172 files changed

+5449
-9039
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

172 files changed

+5449
-9039
lines changed

.azuredevops/pipelines/build-v2.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,7 @@ jobs:
386386
displayName: "Install dotnet-ef"
387387
condition: always()
388388
inputs:
389-
script: "dotnet tool install --global dotnet-ef"
389+
script: "dotnet tool install --version 7.0.13 --global dotnet-ef"
390390

391391
- task: CmdLine@2
392392
displayName: "Check dotnet-ef version"

.github/workflows/codeql-analysis.yml

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -67,21 +67,9 @@ jobs:
6767
# Prefix the list here with "+" to use these queries and those in the config file.
6868
# queries: ./path/to/local/query, your-org/your-repo/queries@main
6969

70-
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
71-
# If this step fails, then you should remove it and run the build manually (see below)
72-
- name: Autobuild
73-
uses: github/codeql-action/autobuild@v2
74-
75-
# ℹ️ Command-line programs to run using the OS shell.
76-
# 📚 https://git.io/JvXDl
77-
78-
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
79-
# and modify them (or add more) to build your code if your project
80-
# uses a compiled language
81-
82-
#- run: |
83-
# make bootstrap
84-
# make release
70+
- name: Build solution
71+
run: |
72+
dotnet build ./Source/CdrAuthServer.sln --configuration 'Release'
8573
8674
- name: Perform CodeQL Analysis
8775
uses: github/codeql-action/analyze@v2

.github/workflows/docker.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,12 @@ jobs:
7878

7979
- name: Image digest
8080
run: echo ${{ steps.docker_build.outputs.digest }}
81+
82+
- name: Docker Hub Description
83+
if: ${{ github.repository_owner == 'ConsumerDataRight' && github.ref_name == 'main' }}
84+
uses: peter-evans/dockerhub-description@v3
85+
with:
86+
username: ${{ secrets.DOCKERHUB_USERNAME }}
87+
password: ${{ secrets.DOCKERHUB_TOKEN }}
88+
repository: ${{ env.DOCKER_IMAGE }}
89+
enable-url-completion: true

.github/workflows/sonarcloud-analysis.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,25 +31,26 @@ jobs:
3131
runs-on: windows-latest
3232

3333
steps:
34-
- name: Set up JDK 11
35-
uses: actions/setup-java@v1
34+
- name: Set up JDK 17
35+
uses: actions/setup-java@v3
3636
if: ${{ env.sonarSecret != 0 }} # Only run scan if secret use is allowed - requires secrets to run successfully
3737
with:
38-
java-version: 1.11
39-
- uses: actions/checkout@v2
38+
java-version: 17
39+
distribution: 'zulu' # Alternative distribution options are available.
40+
- uses: actions/checkout@v3
4041
if: ${{ env.sonarSecret != 0 }} # Only run scan if secret use is allowed - requires secrets to run successfully
4142
with:
4243
fetch-depth: 0 # Shallow clones should be disabled for a better relevancy of analysis
4344
- name: Cache SonarCloud packages
44-
uses: actions/cache@v2.1.6
45+
uses: actions/cache@v3
4546
if: ${{ env.sonarSecret != 0 }} # Only run scan if secret use is allowed - requires secrets to run successfully
4647
with:
4748
path: ~\sonar\cache
4849
key: ${{ runner.os }}-sonar
4950
restore-keys: ${{ runner.os }}-sonar
5051
- name: Cache SonarCloud scanner
5152
id: cache-sonar-scanner
52-
uses: actions/cache@v2.1.6
53+
uses: actions/cache@v3
5354
if: ${{ env.sonarSecret != 0 }} # Only run scan if secret use is allowed - requires secrets to run successfully
5455
with:
5556
path: .\.sonar\scanner

CHANGELOG.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,27 @@
11
# Changelog
22
All notable changes to this project will be documented in this file.
33

4-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

77
## [Unreleased]
88

9-
## [1.0.3] - 2023-10-26
9+
## [1.1.1] - 2023-11-29
1010

1111
### Changed
1212
- Updated npm packages used for Authorisation Server User Interface.
1313

14+
## [1.1.0] - 2023-10-26
15+
16+
### Changed
17+
- Updated npm packages used for Authorisation Server User Interface.
18+
- Refactored automated tests to use a shared NuGet package.
19+
20+
## [1.0.3] - 2023-10-03
21+
22+
### Changed
23+
- Configurable OSCP check added for mtls client certificates. By default it is disabled.
24+
1425
## [1.0.2] - 2023-06-20
1526

1627
### Changed

CODE_OF_CONDUCT.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ the community.
115115
## Attribution
116116

117117
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118-
version 2.0, available at
119-
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120120

121121
Community Impact Guidelines were inspired by
122122
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
@@ -126,7 +126,7 @@ For answers to common questions about this code of conduct, see the FAQ at
126126
at [https://www.contributor-covenant.org/translations][translations].
127127

128128
[homepage]: https://www.contributor-covenant.org
129-
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130130
[Mozilla CoC]: https://github.com/mozilla/diversity
131131
[FAQ]: https://www.contributor-covenant.org/faq
132132
[translations]: https://www.contributor-covenant.org/translations

Help/debugging/HELP.md

Lines changed: 49 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,57 @@
1-
<h2>To get started, clone the source code</h2>
2-
<div style="margin-left:18px;">
3-
1. Create a folder called CDR<br />
4-
2. Navigate to this folder<br />
5-
3. Clone the repo as a subfolder of this folder using the following command;<br />
6-
<div style="margin-left:18px;">
7-
git clone https://github.com/ConsumerDataRight/authorisation-server.git<br />
8-
</div>
9-
4. Install the required certificates. See certificate details <a href="../../CertificateManagement/README.md" title="Certificate Management" alt="Certificate Management - CertificateManagement/README.md"> here</a>.<br />
10-
5. Start the projects in the solution, can be done in multiple ways, examples below are from .Net command line and using MS Visual Studio<br />
11-
</div>
12-
13-
<h2>.Net command line</h2>
14-
<div style="margin-left:18px;">
15-
<p>1. Download and install the free <a href="https://docs.microsoft.com/en-us/windows/terminal/get-started" title="Download the free Windows Terminal here" alt="Download the free MS Windows Terminal here">MS Windows Terminal</a>
16-
<br />
17-
2. Use the <a href="../../Source/Start-Auth-Server.bat" title="Use the Start-Auth-Server .Net CLI batch file here" alt="Use the Start-Auth-Server .Net CLI batch file here">Start-Auth-Server</a> batch file to build and run the required projects to start the Mock Data Holder.
18-
</p>
1+
# Getting Started
2+
To get started, clone the source code from the GitHub repositories by following the steps below:
3+
4+
1. Create a folder called CDR.
5+
2. Navigate to this folder.
6+
3. Clone the repo as a subfolder of this folder using the following command:
7+
```
8+
git clone https://github.com/ConsumerDataRight/authorisation-server.git
9+
```
10+
4. Install the required certificates. See certificate details [here](../../CertificateManagement/README.md "Certificate Management").
11+
5. Start the projects in the solution. This can be done in multiple ways. This guide explains how to do this using .Net command line and using MS Visual Studio.
12+
13+
## .Net command line
14+
15+
1. Download and install the free [MS Windows Terminal](https://docs.microsoft.com/en-us/windows/terminal/get-started "Download the free Windows Terminal here").
16+
2. Use the [Start-Auth-Server](../../Source/Start-Auth-Server.bat "Use the Start-Auth-Server.bat .Net CLI batch file here") batch file to build and run the required projects to start the Mock Data Holder.
17+
1918

2019
[<img src="./images/DotNet-CLI-Running.png" width='600' alt="Start projects from .Net CLI"/>](./images/DotNet-CLI-Running.png)
21-
<br />
22-
This will create the LocalDB database by default and seed the database with the supplied sample data.
23-
<p>LocalDB is installed as part of MS Visual Studio. If using MS VSCode, the MS SQL extension will need to be installed.</p>
24-
<p>You can connect to the database from MS Visual Studio using the SQL Explorer, or from MS SQL Server Management Studio (SSMS) using
25-
the following settings; <br />
26-
Server type: Database Engine <br />
27-
Server name: (LocalDB)\MSSQLLocalDB <br />
28-
Authentication: Windows Authentication<br />
29-
</p>
30-
</div>
31-
32-
<h2>MS Visual Studio</h2>
33-
<div style="margin-left:18px;">
34-
<p>To launch the application using MS Visual Studio, the following projects need to be started:</p>
35-
<p> CdrAuthServer <br />
36-
CdrAuthServer.mTLS.Gateway <br />
37-
CdrAuthServer.TLS.Gateway<br />
38-
</p>
39-
40-
<p>1. Navigate to the solution properties and select a "Start" action for the required projects.</p>
20+
21+
This will create the LocalDB instance by default and seed the database with the supplied sample data.
22+
23+
LocalDB is installed as part of MS Visual Studio. If using MS VSCode, the MS SQL extension will need to be installed.
24+
25+
You can connect to the database from MS Visual Studio using the SQL Explorer, or from MS SQL Server Management Studio (SSMS) using the following settings:
26+
```
27+
Server type: Database Engine
28+
Server name: (LocalDB)\\MSSQLLocalDB
29+
Authentication: Windows Authentication
30+
```
31+
## MS Visual Studio
32+
33+
### Start the Mock Data Holder
34+
To launch the application using MS Visual Studio, the following projects need to be started:
35+
```
36+
CdrAuthServer
37+
CdrAuthServer.mTLS.Gateway
38+
CdrAuthServer.TLS.Gateway
39+
```
40+
41+
1. Navigate to the solution properties and select a "Start" action for the required projects.
4142

4243
[<img src="./images/MS-Visual-Studio-Select-projects.png" width='600' alt="Project selected to be started"/>](./images/MS-Visual-Studio-Select-projects.png)
43-
<br />
44-
<p>2. Click "Start" to start the Authorisation Server solution.</p>
44+
45+
2. Click "Start" to start the Authorisation Server solution.
4546

4647
[<img src="./images/MS-Visual-Studio-Start-No-Debug.png" width='600' alt="Start the project"/>](./images/MS-Visual-Studio-Start-No-Debug.png)
47-
<br />
48-
Output windows will be launched for each of the projects set to start. <br />
49-
These will show the logging messages as sent to the console in each of the running projects. E.g.<br />
48+
49+
3. Output windows will be launched for each of the projects set to start. \
50+
These will show the logging messages as sent to the console in each of the running projects. E.g.
51+
5052
[<img src="./images/MS-Visual-Studio-Running.png" width='600' alt="Project running"/>](./images/MS-Visual-Studio-Running.png)
51-
<br />
52-
To run the solution in debug mode, simply follow the steps outlined above and click on the "Start" button as shown in the image below: <br />
53-
[<img src="./images/MS-Visual-Studio-Start.png" width='600' alt="Start the project"/>](./images/MS-Visual-Studio-Start.png)
5453

55-
</div>
54+
4. To run the solution in debug mode, simply follow the steps outlined above and click on the "Start" \
55+
button as shown in the image below:
56+
57+
[<img src="./images/MS-Visual-Studio-Start.png" width='600' alt="Start the project"/>](./images/MS-Visual-Studio-Start.png)

0 commit comments

Comments
 (0)