Skip to content

_naming

_naming

Shared naming conventions for SSH key files.

effective_ssh_key_name(scope, *, ssh_key_name=None, key_type='ed25519')

Return the SSH key filename to use.

Precedence
  1. Explicit ssh_key_name (from caller config)
  2. Derived default: id_<type>_<scope>
Source code in src/terok_sandbox/_util/_naming.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
def effective_ssh_key_name(
    scope: str, *, ssh_key_name: str | None = None, key_type: str = "ed25519"
) -> str:
    """Return the SSH key filename to use.

    Precedence:
      1. Explicit *ssh_key_name* (from caller config)
      2. Derived default: ``id_<type>_<scope>``
    """
    if ssh_key_name:
        return ssh_key_name
    algo = "ed25519" if key_type == "ed25519" else "rsa"
    return f"id_{algo}_{scope}"