Skip to content

Commit

Permalink
rename Configuration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TimCsaky committed Apr 19, 2024
1 parent 17dfd17 commit 868101f
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/Authentication.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
This page describes how to authenticate requests to the COMS API. The [Authentication Modes](Configuration.md#authentication-modes) must be enabled in the COMS configuration.
This page describes how to authenticate requests to the COMS API. The [Authentication Modes](Config.md#authentication-modes) must be enabled in the COMS configuration.

**Note:** The BC Gov Hosted COMS service only allows OIDC Authentication using JWT's issued by the [Pathfinder SSO `standard` keycloak realm](https://github.com/bcgov/sso-keycloak/wiki#standard-service)).

## OIDC Authentication

With [OIDC mode](Configuration.md#oidc-keycloak) enabled, requests to the COMS API can be authenticated using a **User ID token** (JWT) issued by an OIDC authentication realm. The JWT should be added in an Authorization header (type `Bearer` token).
With [OIDC mode](Config.md#oidc-keycloak) enabled, requests to the COMS API can be authenticated using a **User ID token** (JWT) issued by an OIDC authentication realm. The JWT should be added in an Authorization header (type `Bearer` token).

COMS will only accept JWT's issued by one OIDC realm (specified in the COMS config). JWT's are typically issued to an application and saved to a user's browser when he/she signs-in to a website through the [Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth). Both the website (client app) and the instance of COMS must be [configured to use the same OIDC authentication realm](https://github.com/bcgov/common-object-management-service/blob/master/app/README.md#keycloak-variables) in order for the JWT to be valid.

Expand All @@ -31,12 +31,12 @@ COMS uses the redirect flow by default because it avoids unnecessary network hop

## Basic Auth

If [Basic Auth Mode](Configuration.md#basic-auth) is enabled in your COMS instance, requests to the COMS API can be authenticated using an HTTP Authorization header (type `Basic`) containing the username and password configured in COMS.
If [Basic Auth Mode](Config.md#basic-auth) is enabled in your COMS instance, requests to the COMS API can be authenticated using an HTTP Authorization header (type `Basic`) containing the username and password configured in COMS.

This mode offers more direct access for a 'service account' authorized in the scope of the application rather than for a specific user and by-passes the COMS object/bucket permission model.

Basic Auth mode is not available on the BC Gov hosted COMS service.

## Unauthenticated Mode

[Unauthenticated Mode](Configuration.md#unauthenticated-auth) configuration is generally recommended when you expect to run COMS in a highly secured network environment and do not have concerns about access control to objects as you have another application handling that already.
[Unauthenticated Mode](Config.md#unauthenticated-auth) configuration is generally recommended when you expect to run COMS in a highly secured network environment and do not have concerns about access control to objects as you have another application handling that already.
2 changes: 1 addition & 1 deletion docs/Buckets.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

### Configuring Buckets

- COMS is [configured with a 'default' bucket](Configuration.md#object-storage). Various object management endpoints will use this bucket if no `bucketId` parameter is provided. (**Note:** the default bucket fall-back behaviour is not available in the BC Gov Hosted COMS service.)
- COMS is [configured with a 'default' bucket](Config.md#object-storage). Various object management endpoints will use this bucket if no `bucketId` parameter is provided. (**Note:** the default bucket fall-back behaviour is not available in the BC Gov Hosted COMS service.)

- Additional buckets can be added to the COMS system using the [createBucket](https://coms.api.gov.bc.ca/api/v1/docs#tag/Bucket/operation/createBucket) endpoint.

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/Hosted-Service-Onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Some important aspects of the hosted service to consider:

### Privacy Controls

- The stricter [Privacy Controls](Configuration.md#privacy-controls) setting is enabled in the Hosted service (requires `READ` permission on bucket or object to discover or access the file and related data). This removes the abiility to search for objects that you don't have permissions for.
- The stricter [Privacy Controls](Config.md#privacy-controls) setting is enabled in the Hosted service (requires `READ` permission on bucket or object to discover or access the file and related data). This removes the abiility to search for objects that you don't have permissions for.

### Additional features

Expand Down
4 changes: 2 additions & 2 deletions docs/Hosting-Considerations.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ Feature Comparison:
|   Database Custodians |   Us |   You
|   Object Storage Custodians |   You |   You
| &nbsp; Multi-bucket support | <ul><li>[x] </li></ul> | <ul><li>[x] </li></ul>
| &nbsp; Strict [Privacy mode](Configuration.md#privacy-controls) | <ul><li>[x] </li></ul> | &nbsp; Configurable
| &nbsp; [No-Auth mode](Configuration.md#unauthenticated)| <ul><li>[ ] </li></ul> | &nbsp; Configurable
| &nbsp; Strict [Privacy mode](Config.md#privacy-controls) | <ul><li>[x] </li></ul> | &nbsp; Configurable
| &nbsp; [No-Auth mode](Config.md#unauthenticated)| <ul><li>[ ] </li></ul> | &nbsp; Configurable
| &nbsp; Custom configuration options | <ul><li>[ ] </li></ul> | <ul><li>[x] </li></ul>
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ nav:
- Overview: Architecture.md
- Database: Architecture/#database-structure
- Code Design: Architecture/#code-design
- Configuration Options: Configuration.md
- Configuration Options: Config.md
- The Hosted Service:
- Hosting Considerations: Hosting-Considerations.md
- Hosted Service Architecture: Architecture-Hosted.md
Expand Down

0 comments on commit 868101f

Please sign in to comment.