httk.core.project.anchor

The httk project anchor: the httk_project directory and its metadata.

A project is to a campaign what a Git repository is to a source tree: a directory marked, at its root, by a small control directory that every command discovers by walking upward from wherever it is run. Here that directory is httk_project and its manifest is project.json.

This module owns the anchor and nothing above it. It creates the control directory, reads and validates project.json, walks upward to discover the nearest project, and manages the project’s Ed25519 identity key and the trust anchors a signed manifest is later checked against. It creates no workflow workspace: that is an add-on a workflow installation layers on top of the anchor, so the anchor stays useful to a core-only installation.

The on-disk format — the format and format_version members, the key file names and modes, and the directory layout — is shared with httk-workflow so its manifests and repair interoperate with core projects.

Attributes

PROJECT_DIRECTORY

PROJECT_FILE

PUBLIC_KEY_PREFIX

Exceptions

LegacyProjectError

Raised when discovery finds an httk v1 ht.project directory.

Functions

discover_project([start])

Find the nearest project root, or refuse a legacy one, at or above start.

require_project([start])

Return the nearest project root, refusing when there is none.

read_project(root)

Read and validate the project.json of the project rooted at root.

read_project_section(root, name)

Return one named object member of project.json, empty when absent.

write_project_section(root, name, value)

Store one named object member of project.json and return the metadata.

format_public_key(raw)

Return the recorded representation of one raw Ed25519 public key.

parse_public_key(value)

Decode a recorded public key, accepting the bare base64 spelling too.

canonical_public_key(value)

Normalize any accepted public key spelling to the recorded one.

key_fingerprint(value)

Return the stable display fingerprint of one public key.

project_public_key_path(root)

Return where a project keeps its own signing key's public half.

read_public_key_file(path)

Read one public-key file and return its recorded public key.

pinned_project_key(metadata)

Return the project's own pinned public key, or None when absent.

trusted_project_keys(metadata)

Return every key metadata pins: the project's own and any adopted one.

pin_project_key([root])

Adopt the project's current keys/project.pub as its trust anchor.

trust_project_key(root, key)

Adopt one further public key as a trust anchor of this project.

initialize_project(root, *, name[, description, ...])

Initialize the project anchor: its metadata, its key, and its remotes dir.

import_v1_project(root, *[, source, name])

Create the project anchor from a legacy ht.project directory.

Module Contents

httk.core.project.anchor.PROJECT_DIRECTORY = 'httk_project'
httk.core.project.anchor.PROJECT_FILE = 'project.json'
httk.core.project.anchor.PUBLIC_KEY_PREFIX = 'ed25519:'
exception httk.core.project.anchor.LegacyProjectError(message, *, root)

Bases: ValueError

Raised when discovery finds an httk v1 ht.project directory.

Carries the offending directory as root so a caller that deliberately handles it (for example read-only verification of a v1 manifest) does not have to parse the message.

Parameters:

  • message (str) – Diagnostic explaining the legacy project and its remedy.

  • root (pathlib.Path) – Directory containing the legacy project marker.

root
httk.core.project.anchor.discover_project(start=None)

Find the nearest project root, or refuse a legacy one, at or above start.

Discovery walks from start and its parents, treating a file start as its containing directory. If it finds a legacy ht.project marker, the exception identifies the required remedy: run httk project import-v1 PATH.

Parameters:

start (str | os.PathLike[str] | None) – Directory or file from which to begin the upward search, or None for the current directory.

Returns:

Nearest project root, or None when no marker is found.

Raises:

httk.core.project.LegacyProjectError – If discovery finds a v1 project marker.

Return type:

pathlib.Path | None

httk.core.project.anchor.require_project(start=None)

Return the nearest project root, refusing when there is none.

Parameters:

start (str | os.PathLike[str] | None) – Directory or file from which to begin the upward search, or None for the current directory.

Returns:

Nearest project root.

Raises:
Return type:

pathlib.Path

httk.core.project.anchor.read_project(root)

Read and validate the project.json of the project rooted at root.

Parameters:

root (str | os.PathLike[str]) – Project root whose manifest is read.

Returns:

Validated project metadata.

Raises:

ValueError – If the manifest is not an httk project manifest.

Return type:

dict[str, object]

httk.core.project.anchor.read_project_section(root, name)

Return one named object member of project.json, empty when absent.

A section is a top-level member of the project manifest that some layer above the anchor owns — the workflow workspace registry, a campaign map — and reads and writes as a whole. The anchor does not interpret the member; it only guarantees that what a caller stores under a name comes back as the object it was, and refuses a member that some other writer has left as a non-object so a caller never silently reads a scalar as a mapping.

Parameters:

  • root (str | os.PathLike[str]) – Project root whose manifest is read.

  • name (str) – Top-level manifest member to retrieve.

Returns:

A copy of the named object, or an empty object when absent.

Raises:

ValueError – If the named manifest member is not an object.

Return type:

dict[str, object]

httk.core.project.anchor.write_project_section(root, name, value)

Store one named object member of project.json and return the metadata.

The write is an ordinary read-modify-write of the validated manifest, so the members the anchor owns are preserved untouched and only the named section is replaced. The section must be a mapping; the anchor stores its members verbatim without interpreting them.

Parameters:
Returns:

Updated project metadata.

Raises:

ValueError – If the named section is not a mapping.

Return type:

dict[str, object]

httk.core.project.anchor.format_public_key(raw)

Return the recorded representation of one raw Ed25519 public key.

Parameters:

raw (bytes) – Raw public-key bytes to record.

Returns:

Canonical prefixed public-key text.

Raises:

ValueError – If the key is not 32 bytes long.

Return type:

str

httk.core.project.anchor.parse_public_key(value)

Decode a recorded public key, accepting the bare base64 spelling too.

Parameters:

value (str) – Public-key text to decode.

Returns:

Raw public-key bytes.

Raises:

ValueError – If the algorithm, encoding, or key length is invalid.

Return type:

bytes

httk.core.project.anchor.canonical_public_key(value)

Normalize any accepted public key spelling to the recorded one.

Parameters:

value (str) – Accepted public-key text to normalize.

Returns:

Canonical prefixed public-key text.

Raises:

ValueError – If the public-key text is invalid.

Return type:

str

httk.core.project.anchor.key_fingerprint(value)

Return the stable display fingerprint of one public key.

Parameters:

value (str) – Public-key text whose fingerprint is calculated.

Returns:

Stable SHA-256 fingerprint text.

Raises:

ValueError – If the public-key text is invalid.

Return type:

str

httk.core.project.anchor.project_public_key_path(root)

Return where a project keeps its own signing key’s public half.

Parameters:

root (str | os.PathLike[str]) – Project root containing the anchor.

Returns:

Path to the project’s public key file.

Return type:

pathlib.Path

httk.core.project.anchor.read_public_key_file(path)

Read one public-key file and return its recorded public key.

Parameters:

path (str | os.PathLike[str]) – Public-key file to read.

Returns:

Canonical public-key text from the first line.

Raises:

ValueError – If the file cannot be read, is empty, or contains an invalid key.

Return type:

str

httk.core.project.anchor.pinned_project_key(metadata)

Return the project’s own pinned public key, or None when absent.

Parameters:

metadata (collections.abc.Mapping[str, object]) – Project metadata containing the optional public-key member.

Returns:

Canonical pinned key, or None when the metadata has no key.

Raises:

ValueError – If the pinned key is present but invalid.

Return type:

str | None

httk.core.project.anchor.trusted_project_keys(metadata)

Return every key metadata pins: the project’s own and any adopted one.

The pinned key of project.json is the trust anchor a manifest is checked against. trusted_keys carries the additional anchors an operator has adopted deliberately — most often the legacy identities an imported httk v1 project signed its old manifests with.

Parameters:

metadata (collections.abc.Mapping[str, object]) – Project metadata whose trust anchors are read.

Returns:

Unique canonical project and adopted trust anchors.

Raises:

ValueError – If trusted_keys is not a string array or contains an invalid key.

Return type:

tuple[str, Ellipsis]

httk.core.project.anchor.pin_project_key(root=None)

Adopt the project’s current keys/project.pub as its trust anchor.

Pinning is always an explicit act. Verification trusts the key recorded in project.json and never the key a manifest carries in its own header, so adopting the key that is in the tree right now is exactly the decision an operator has to make consciously for an older project that has no pin.

Parameters:

root (str | os.PathLike[str] | None) – Project root, or None to discover the nearest project.

Returns:

Updated project metadata.

Raises:

ValueError – If no project exists or its public key is invalid.

Return type:

dict[str, object]

httk.core.project.anchor.trust_project_key(root, key)

Adopt one further public key as a trust anchor of this project.

Parameters:

  • root (str | os.PathLike[str] | None) – Project root, or None to discover the nearest project.

  • key (str) – Public key to add to the project’s trusted anchors.

Returns:

Updated project metadata.

Raises:

ValueError – If no project exists, the key is invalid, or trusted_keys is invalid.

Return type:

dict[str, object]

httk.core.project.anchor.initialize_project(root, *, name, description='', manifest_exclusions=())

Initialize the project anchor: its metadata, its key, and its remotes dir.

This creates only the anchor — httk_project with project.json, the project’s Ed25519 signing key, and the remotes directory. It creates no workflow workspace; a workflow installation layers that on top of the anchor so that a core-only installation still has a working project.

Parameters:

  • root (str | os.PathLike[str]) – Directory in which to create the project anchor.

  • name (str) – Human-readable project name.

  • description (str) – Optional project description.

  • manifest_exclusions (collections.abc.Iterable[str]) – Relative paths excluded from project manifests.

Returns:

Newly written project metadata.

Raises:

httk.core.project.LegacyProjectError – If root contains a v1 project marker.

Return type:

dict[str, object]

httk.core.project.anchor.import_v1_project(root, *, source=None, name=None)

Create the project anchor from a legacy ht.project directory.

Only the anchor is created: the project’s metadata and the adoption of the legacy identities its old manifests were signed with. A workflow installation adds the workspace and any queue import on top of this.

Parameters:

  • root (str | os.PathLike[str]) – Directory in which to create the new project anchor.

  • source (str | os.PathLike[str] | None) – Legacy project directory, or root/ht.project when omitted.

  • name (str | None) – Optional replacement project name.

Returns:

Imported project metadata.

Raises:

FileNotFoundError – If the legacy project directory does not exist.

Return type:

dict[str, object]