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

add JAAS security doc #62

Merged
merged 5 commits into from
Oct 8, 2024
Merged

add JAAS security doc #62

merged 5 commits into from
Oct 8, 2024

Conversation

kian99
Copy link
Contributor

@kian99 kian99 commented Oct 3, 2024

Description

This PR adds a doc titled "JAAS Security".

The doc covers any areas that are important to the security of JAAS.
Where relevant we cover the use of cryptography, algorithms used and packages used.

Resolves: CSS-9384

- The doc covers the use of cryptography in JAAS, algorithms used and packages used.
@kian99 kian99 requested review from babakks, alesstimec, SimoneDutto, ale8k and pkulik0 and removed request for babakks October 3, 2024 10:20
Copy link
Contributor

@SimoneDutto SimoneDutto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very well done, some suggestions

reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
^^^^^^^^^^^^^^^^^

JAAS does not currently enforce TLS when communicating with PostgreSQL.
But this can be achieved when using the PostgreSQL charm.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put this differently.
It is possible to achieve TLS by using the PostgresSQL charm and configure it properly by following https://charmhub.io/postgresql-k8s/docs/t-enable-tls

malicious use of your online credentials. Read more on CORS
`here <https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#what_requests_use_cors>`__.

JAAS supports the use of CORS headers specifically for the purposes of the Juju
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to add that CORS is not supported for WS communications?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I'll need to mention that.

Copy link
Member

@babakks babakks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing doc! Thanks for this.

reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
- used LLM to simplify wording where possible
@kian99
Copy link
Contributor Author

kian99 commented Oct 3, 2024

@babakks @SimoneDutto I was curious if an LLM could improve my wording and since these are public docs I tried it and was quite impressed with the changes. If you want, please take another look. The latest commit is purely the LLM changes after I went over them and accepted the changes I wanted, for example I wasn't happy with the changes to the Macaroon section so I left that one as is.

I'll address your comments now. Many have already been solved.

reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
@kian99 kian99 force-pushed the add-jaas-security-doc branch from ae0dc2a to 1bbecc2 Compare October 3, 2024 14:14
@kian99 kian99 force-pushed the add-jaas-security-doc branch from 1bbecc2 to 5f84416 Compare October 3, 2024 15:14
Copy link
Contributor

@ale8k ale8k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some comments, I'll lgtm it but plz do them

reference/security.rst Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
reference/security.rst Show resolved Hide resolved
reference/security.rst Outdated Show resolved Hide resolved
@kian99 kian99 merged commit 201d3a7 into canonical:v3 Oct 8, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants