Skip to content

gufo.acme.clients.web

A WebAcmeClient implementation.

WebAcmeClient

Bases: AcmeClient

A webserver-backed ACME client.

Fulfills http-01 challenge by creating and removing token files in predefined directories.

Parameters:

Name Type Description Default
path Union[str, Path]

Path mapped to /.well-known/acme-challenges directory.

required

clear_http_01(domain, challenge) async

Remove provisioned token.

Parameters:

Name Type Description Default
domain str

Domain name

required
challenge AcmeChallenge

AcmeChallenge instance, containing token.

required

Raises:

Type Description
AcmeFulfillmentFailed

On error.

fulfill_http_01(domain, challenge) async

Perform http-01 fullfilment.

Put token to / file.

Parameters:

Name Type Description Default
domain str

Domain name

required
challenge AcmeChallenge

AcmeChallenge instance, containing token.

required

Returns:

Type Description
bool

True - on succeess

Raises:

Type Description
AcmeFulfillmentFailed

On error.