certwrangler.stores.local module#

pydantic model certwrangler.stores.local.LocalStore[source]#

Bases: Store

Local storage driver.

Show Entity Relationship Diagram

digraph "Entity Relationship Diagram created by erdantic" { graph [fontcolor=gray66, fontname="Times New Roman,Times,Liberation Serif,serif", fontsize=9, nodesep=0.5, rankdir=LR, ranksep=1.5 ]; node [fontname="Times New Roman,Times,Liberation Serif,serif", fontsize=14, label="\N", shape=plain ]; edge [dir=both]; "certwrangler.stores.local.LocalStore" [label=<<table border="0" cellborder="1" cellspacing="0"><tr><td port="_root" colspan="2"><b>LocalStore</b></td></tr><tr><td>driver</td><td port="driver">Literal['local']</td></tr><tr><td>path</td><td port="path">Path</td></tr></table>>, tooltip="certwrangler.stores.local.LocalStore&#xA;&#xA;Local storage driver.&#xA;"]; }

Show JSON schema
{
   "title": "LocalStore",
   "description": "Local storage driver.",
   "type": "object",
   "properties": {
      "driver": {
         "const": "local",
         "title": "Driver",
         "type": "string"
      },
      "path": {
         "description": "Path to where this driver should publish certs.",
         "format": "path",
         "title": "Path",
         "type": "string"
      }
   },
   "required": [
      "driver",
      "path"
   ]
}

Fields:
field driver: Literal['local'] [Required]#
field path: Path [Required]#

Path to where this driver should publish certs.

initialize() None[source]#

Create the target directory if it does not already exist.

Raises:

StoreError – Raised on errors when creating the directory defined by path.

publish(cert: Cert) None[source]#

Publish the cert, key, chain and fullchain to the target directory. This will update the files if the contents changed, no-op otherwise.

Raises:

StoreError – Raised on errors creating, reading, or writing files under the directory defined by path.

_get_digest(obj: str | Path) str[source]#

Get the sha256sum of either a str or Path object.