From f82e88d458f51055bcbfde7b4a6e535956837cd5 Mon Sep 17 00:00:00 2001
From: Sergey Beryozkin <sberyozkin@gmail.com>
Date: Tue, 14 May 2024 18:37:22 +0100
Subject: [PATCH] Document WebSockets Next security

---
 docs/src/main/asciidoc/security-overview.adoc |  6 ++
 .../asciidoc/websockets-next-reference.adoc   | 64 +++++++++++++++++++
 2 files changed, 70 insertions(+)

diff --git a/docs/src/main/asciidoc/security-overview.adoc b/docs/src/main/asciidoc/security-overview.adoc
index c4620b815fba1..81217b8b412c1 100644
--- a/docs/src/main/asciidoc/security-overview.adoc
+++ b/docs/src/main/asciidoc/security-overview.adoc
@@ -53,6 +53,12 @@ For guidance on testing Quarkus Security features and ensuring that your Quarkus
 
 == More about security features in Quarkus
 
+=== WebSockets Next security
+
+The `quarkus-websockets-next` extension provides a modern, efficient implementation of the WebSocket API.
+It also provides an integration with Quarkus security.
+For more information, see the xref:websockets-next-reference.adoc#websocket-next-security[Security] section of the Quarkus "WebSockets Next reference" guide.
+
 [[cross-origin-resource-sharing]]
 === Cross-origin resource sharing
 
diff --git a/docs/src/main/asciidoc/websockets-next-reference.adoc b/docs/src/main/asciidoc/websockets-next-reference.adoc
index 3e76df74bf969..f54cb783d5a5b 100644
--- a/docs/src/main/asciidoc/websockets-next-reference.adoc
+++ b/docs/src/main/asciidoc/websockets-next-reference.adoc
@@ -574,6 +574,70 @@ void pong(Buffer data) {
 }
 ----
 
+[[websocket-next-security]]
+== Security
+
+The websocket endpoint callback methods can now be secured with security annotations such as `io.quarkus.security.Authenticated`,
+`jakarta.annotation.security.RolesAllowed` and other annotations listed in the xref:security-authorize-web-endpoints-reference.adoc#standard-security-annotations[Supported security annotations] documentation.
+
+For example:
+
+[source, java]
+----
+package io.quarkus.websockets.next.test.security;
+
+import jakarta.annotation.security.RolesAllowed;
+import jakarta.inject.Inject;
+
+import io.quarkus.security.ForbiddenException;
+import io.quarkus.security.identity.SecurityIdentity;
+import io.quarkus.websockets.next.OnError;
+import io.quarkus.websockets.next.OnOpen;
+import io.quarkus.websockets.next.OnTextMessage;
+import io.quarkus.websockets.next.WebSocket;
+
+@WebSocket(path = "/end")
+public static class Endpoint {
+
+    @Inject
+    SecurityIdentity currentIdentity;
+
+    @OnOpen
+    String open() {
+        return "ready";
+    }
+
+    @RolesAllowed("admin")
+    @OnTextMessage
+    String echo(String message) { <1>
+        if (!currentIdentity.hasRole("admin")) {
+            throw new IllegalStateException();
+        }
+        return message;
+    }
+
+    @OnError
+    String error(ForbiddenException t) { <2>
+        return "forbidden:" + currentIdentity.getPrincipal().getName();
+    }
+}
+----
+<1> The echo callback method can only be invoked if the current security identity has an `admin` role.
+<2> The error handler is invoked in case of the authorization failure.
+
+`SecurityIdentity` is initially created during a secure HTTP upgrade and associated with the websocket connection.
+
+Currently, for an HTTP upgrade be secured, users must configure an HTTP policy protecting the HTTP upgrade path.
+For example, to secure the `open()` method in the above websocket endpoint, one can add the following authentication policy:
+
+[source,properties]
+----
+quarkus.http.auth.permission.secured.paths=/end
+quarkus.http.auth.permission.secured.policy=authenticated
+----
+
+Other options for securing HTTP upgrade requests, such as using the security annotations, will be explored in the future.
+
 [[websocket-next-configuration-reference]]
 == Configuration reference