Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: logging #2859

Merged
merged 4 commits into from
Nov 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 70 additions & 1 deletion docs/admin/fido/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,73 @@ tags:
- fido
---

This page will be the landing page for the Janssen Project admin documentation
### Log level and Logging Layout Parameters of Janssen's FIDO2 server:

| Field named | Example | Description|
|loggingLevel | "INFO" or "TRACE" or "DEBUG" | Logging level for FIDO2 server|
|loggingLayout |"text" or "json" |Contents of logs as plain text or json format|

#### 1. Read Configuration parameters:

Use the following command to obtain configuration parameters:

`/opt/jans/jans-cli/config-cli.py --operation-id get-properties-fido2`

Response:
```
{
"issuer":"https://.jans.io",
"baseEndpoint":"https://my-jans-server.jans.io/jans-fido2/restv1",
"cleanServiceInterval":60,
"cleanServiceBatchChunkSize":10000,
"useLocalCache":true,
"disableJdkLogger":true,
"loggingLevel":"INFO",
"loggingLayout":"text",
"externalLoggerConfiguration":"",
"metricReporterInterval":300,
"metricReporterKeepDataDays":15,
"metricReporterEnabled":true,
"personCustomObjectClassList":[
"jansCustomPerson",
"jansPerson"
],
"fido2Configuration":{
"authenticatorCertsFolder":"/etc/jans/conf/fido2/authenticator_cert",
"mdsCertsFolder":"/etc/jans/conf/fido2/mds/cert",
"mdsTocsFolder":"/etc/jans/conf/fido2/mds/toc",
"serverMetadataFolder":"/etc/jans/conf/fido2/server_metadata",
"requestedCredentialTypes":[
"RS256",
"ES256"
],
"requestedParties":[
{
"name":"https://my-jans-server.jans.io",
"domains":[
"my-jans-server.jans.io"
]
}
],
"userAutoEnrollment":false,
"unfinishedRequestExpiration":180,
"authenticationHistoryExpiration":1296000
}
}

```


#### 2. Update `loggingLevel` or `loggingLayout`:
Steps:
A. Create a JSON file say `/tmp/config_values.json` by editing the JSON from Point 1 and
- edit `loggingLevel` to `TRACE` or `DEBUG` or `INFO`
- edit `loggingLayout` to `text` or `json`

B. Use the following command to update the logging level
`/opt/jans/jans-cli/config-cli.py --operation-id post-config-scripts --data /tmp/config_values.json`


### Location of logs in FIDO2 server:

Logs can be found at `/opt/jans/jetty/jans-fido2/logs`
2 changes: 2 additions & 0 deletions docs/admin/fido/vendor-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,8 +212,10 @@ Example of authenticator metadata:

Metadata entries for trusted authenticators registered with FIDO Alliance can be found on - https://fidoalliance.org/certification/fido-certified-products/


![Metadata](../../assets/fido2-metadata.png)


Draw.io reference for image:
```
<?xml version="1.0" encoding="UTF-8"?>
Expand Down