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.

Sign up for GitHub

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

Jump to bottom

docs: fix/commit tw changes due to early merge of PR2231 #2325

Merged
merged 2 commits into from
Nov 16, 2023
Merged

docs: fix/commit tw changes due to early merge of PR2231 #2325

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
840699e
trying to re-add file server-security.md
quetzalliwrites Nov 16, 2023
e094208
fixed up to line 115
quetzalliwrites Nov 16, 2023
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
10 changes: 5 additions & 5 deletions pages/docs/concepts/asyncapi-document/server-security.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Server Security
title: Server security
weight: 200
---

Server security refers to the measures and practices implemented to protect servers from unauthorized access, data breaches, and other security threats. Server security involves implementing various security mechanisms to ensure the confidentiality, integrity, and availability of server resources.

In the context of AsyncAPI, securing servers ensures secure exchange of messages between clients and servers. While also protecting sensitive data, preventing unauthorized access, and maintaining the overall security of the API or server.

You can describe how is your server secured with `security` property where you define which security schemes can be used with the server in context. Each `server` in the AsyncAPI document can have one or more security schemes declared. A security scheme defines a security requirement that must be satisfied to authorize an operation, such as a API key or username and password.
You can describe how your server is secured with the `security` property where you define which security schemes can be used with the server in context. Each `server` in the AsyncAPI document can have one or more security schemes declared. A security scheme defines a security requirement that must be satisfied to authorize an operation, such as an API key or a username and password.

Here is a example of adding security to your server that shows that different server can have different security mechanisms:
Here is an example of adding security to your server, demonstrating that different servers can employ various security mechanisms:
```yml
asyncapi: 3.0.0
info:
Expand Down Expand Up @@ -38,7 +38,7 @@ components:
description: Download the certificate files from service provider
```

Here is a illustration of securing servers:
Here is an illustration of securing servers:
```mermaid
graph LR
C[servers]
Expand Down Expand Up @@ -112,4 +112,4 @@ Here are some of the security schemes that AsyncAPI supports:
type: scramSha512
```

Although, the `security` property is not mandatory to be implemented, it is a good practise to always secure your server(s) in production. Similarly, having multiple security schemes declared does not necessarily mean that the server is more secure, it really depends on other factors such as the protocol used, use case, business perspective and more. Additionally, you can also [add security on the `operation` level](securing-operations)
Although the `security` property is not mandatory, it is a good practice to always secure your server(s) in production. Similarly, having multiple security schemes declared does not necessarily mean that the server is more secure; it depends on other factors such as the protocol used, use case, business perspective, and more. Additionally, you can also [add security at the `operation` level](securing-operations).