Skip to content

Add security page including TLS and SST descriptions.#337

Merged
edwardalee merged 2 commits into
mainfrom
security
Jun 1, 2026
Merged

Add security page including TLS and SST descriptions.#337
edwardalee merged 2 commits into
mainfrom
security

Conversation

@Jakio815

Copy link
Copy Markdown
Collaborator

No description provided.

@edwardalee edwardalee left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks great! One small point: Perhaps the docs should point out that for proper security, it will be necessary to restrict read permission of the fed-gen and LinguaFrancaRemote folders (the latter on machines that are targets of the deploy scripts). This is because the private keys will appear in these directories.

@Jakio815

Jakio815 commented Jun 1, 2026

Copy link
Copy Markdown
Collaborator Author

@edwardalee

I added a new warning block.

:::warning[Key Protection & Directory Permissions]
For proper security, you must restrict read permissions for the directories containing the generated private keys. Ensure that read access is restricted to authorized users only for:

  1. The local fed-gen directory where the compiler generates the private keys.
  2. The LinguaFrancaRemote folder on remote target machines where deployment or remote launch scripts copy and execute the federated binaries.
    Because private keys (.key or SST credentials) are stored within these directories, leaving them readable by others on the host system compromises the entire federation's security.
    :::

@edwardalee edwardalee merged commit b7aba61 into main Jun 1, 2026
2 checks passed
@Jakio815 Jakio815 deleted the security branch June 1, 2026 16:42
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.

2 participants