From 3f6ba2c6e175dc00c9f3f895cdc72a234a9bcc79 Mon Sep 17 00:00:00 2001 From: Maxim Nesen Date: Thu, 29 Feb 2024 12:43:31 +0100 Subject: [PATCH] Security validation of docs with examples snippets Signed-off-by: Maxim Nesen --- ...idon_security_providers_httpsign_HttpSignProvider.adoc | 6 +++--- .../includes/security/providers/http-basic-auth.adoc | 8 ++++---- .../includes/security/providers/http-digest-auth.adoc | 6 +++--- .../includes/security/providers/http-signatures.adoc | 8 ++++---- .../includes/security/providers/idcs-role-mapper.adoc | 4 ++-- .../main/asciidoc/includes/security/providers/oidc.adoc | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/src/main/asciidoc/config/io_helidon_security_providers_httpsign_HttpSignProvider.adoc b/docs/src/main/asciidoc/config/io_helidon_security_providers_httpsign_HttpSignProvider.adoc index 096c7ecb885..e7f63812a94 100644 --- a/docs/src/main/asciidoc/config/io_helidon_security_providers_httpsign_HttpSignProvider.adoc +++ b/docs/src/main/asciidoc/config/io_helidon_security_providers_httpsign_HttpSignProvider.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2023 Oracle and/or its affiliates. + Copyright (c) 2023, 2024 Oracle and/or its affiliates. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -77,7 +77,7 @@ This type provides the following service implementations: keys: [ { key-id = "service1" - hmac.secret = "${CLEAR=password}" + hmac.secret = "${CLEAR=changeit}" }] } } @@ -108,7 +108,7 @@ This type provides the following service implementations: # This configures the OutboundTargetDefinition signature { key-id = "service1" - hmac.secret = "${CLEAR=password}" + hmac.secret = "${CLEAR=changeit}" } }] } diff --git a/docs/src/main/asciidoc/includes/security/providers/http-basic-auth.adoc b/docs/src/main/asciidoc/includes/security/providers/http-basic-auth.adoc index 26691c230da..0579052287e 100644 --- a/docs/src/main/asciidoc/includes/security/providers/http-basic-auth.adoc +++ b/docs/src/main/asciidoc/includes/security/providers/http-basic-auth.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2018, 2023 Oracle and/or its affiliates. + Copyright (c) 2018, 2024 Oracle and/or its affiliates. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -53,10 +53,10 @@ security: realm: "helidon" users: - login: "john" - password: "${CLEAR=password}" + password: "${CLEAR=changeit}" roles: ["admin"] - login: "jack" - password: "password" + password: "changeit" roles: ["user", "admin"] outbound: - name: "internal-services" @@ -68,7 +68,7 @@ security: hosts: ["*.partner.org"] # Uses this username and password username: "partner-user-1" - password: "${CLEAR=password}" + password: "${CLEAR=changeit}" ---- ==== How does it work? diff --git a/docs/src/main/asciidoc/includes/security/providers/http-digest-auth.adoc b/docs/src/main/asciidoc/includes/security/providers/http-digest-auth.adoc index e9bfd4ad91c..0894566c53d 100644 --- a/docs/src/main/asciidoc/includes/security/providers/http-digest-auth.adoc +++ b/docs/src/main/asciidoc/includes/security/providers/http-digest-auth.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2018, 2023 Oracle and/or its affiliates. + Copyright (c) 2018, 2024 Oracle and/or its affiliates. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -52,10 +52,10 @@ security: server-secret: "${CLEAR=service-wide-secret-not-known-outside}" users: - login: "john" - password: "${CLEAR=password}" + password: "${CLEAR=changeit}" roles: ["admin"] - login: "jack" - password: "password" + password: "changeit" roles: ["user", "admin"] ---- diff --git a/docs/src/main/asciidoc/includes/security/providers/http-signatures.adoc b/docs/src/main/asciidoc/includes/security/providers/http-signatures.adoc index 3a73e1b0bd7..e6b4c0ba01f 100644 --- a/docs/src/main/asciidoc/includes/security/providers/http-signatures.adoc +++ b/docs/src/main/asciidoc/includes/security/providers/http-signatures.adoc @@ -55,13 +55,13 @@ security: keys: - key-id: "service1-hmac" principal-name: "Service1 - HMAC signature" - hmac.secret: "${CLEAR=somePasswordForHmacShouldBeEncrypted}" + hmac.secret: "${CLEAR=changeit}" - key-id: "service1-rsa" principal-name: "Service1 - RSA signature" public-key: keystore: resource.path: "src/main/resources/keystore.p12" - passphrase: "password" + passphrase: "changeit" cert.alias: "service_cert" outbound: - name: "service2-hmac" @@ -69,7 +69,7 @@ security: paths: ["/service2"] signature: key-id: "service1-hmac" - hmac.secret: "${CLEAR=somePasswordForHmacShouldBeEncrypted}" + hmac.secret: "${CLEAR=changeit}" - name: "service2-rsa" hosts: ["localhost"] paths: ["/service2-rsa.*"] @@ -78,7 +78,7 @@ security: private-key: keystore: resource.path: "src/main/resources/keystore.p12" - passphrase: "password" + passphrase: "changeit" key.alias: "myPrivateKey" ---- diff --git a/docs/src/main/asciidoc/includes/security/providers/idcs-role-mapper.adoc b/docs/src/main/asciidoc/includes/security/providers/idcs-role-mapper.adoc index 6785a93866f..3cc1b616b74 100644 --- a/docs/src/main/asciidoc/includes/security/providers/idcs-role-mapper.adoc +++ b/docs/src/main/asciidoc/includes/security/providers/idcs-role-mapper.adoc @@ -1,6 +1,6 @@ /////////////////////////////////////////////////////////////////////////////// - Copyright (c) 2020, 2023 Oracle and/or its affiliates. + Copyright (c) 2020, 2024 Oracle and/or its affiliates. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -57,7 +57,7 @@ security: multitenant: false oidc-config: client-id: "client-id" - client-secret: "client-secret" + client-secret: "changeit" identity-uri: "IDCS identity server address" ---- diff --git a/docs/src/main/asciidoc/includes/security/providers/oidc.adoc b/docs/src/main/asciidoc/includes/security/providers/oidc.adoc index 078a0f761d1..3696452b3b5 100644 --- a/docs/src/main/asciidoc/includes/security/providers/oidc.adoc +++ b/docs/src/main/asciidoc/includes/security/providers/oidc.adoc @@ -35,7 +35,7 @@ security: providers: - oidc: client-id: "client-id-of-this-service" - client-secret: "${CLEAR=client-secret-of-this-service}" + client-secret: "${CLEAR=changeit}" identity-uri: "https://your-tenant.identity-server.com" frontend-uri: "http://my-service:8080" audience: "http://my-service"