package dnsplugin.v1

Get desktop application:
View/edit binary Protocol Buffers messages

DNSProviderService is a protobuf wrapper for the acme DNS challenge API. This is designed to be used to wrap an instance of DNS providers in

• rpc Configure (ConfigureRequest, ConfigureResponse)

  dnsplugin.proto:14

  Configure needs to be called to initialize the provider and set the configuration.

  message ConfigureRequest

  dnsplugin.proto:37

  • string provider_name = 1

  • map<string, string> config = 2

  • repeated string recursive_nameservers = 3

  message ConfigureResponse

  dnsplugin.proto:43

  (message has no fields)

• rpc Present (PresentRequest, PresentResponse)

  dnsplugin.proto:18

  Present presents the DNS challenge TXT records to a DNS provider. This wraps the lego Present call.

  message PresentRequest

  dnsplugin.proto:45

  • string domain = 1

  • string token = 2

  • string key_auth = 3

  message PresentResponse

  dnsplugin.proto:51

  (message has no fields)

• rpc CleanUp (CleanUpRequest, CleanUpResponse)

  dnsplugin.proto:22

  Cleanup requests that DNS challenge TXT records be cleaned up. This wraps the lego Cleanup call.

  message CleanUpRequest

  dnsplugin.proto:53

  • string domain = 1

  • string token = 2

  • string key_auth = 3

  message CleanUpResponse

  dnsplugin.proto:59

  (message has no fields)

• rpc Timeout (TimeoutRequest, TimeoutResponse)

  dnsplugin.proto:26

  Timeout returns the provider's underlying timeout values. This wraps the lego Timeout call.

  message TimeoutRequest

  dnsplugin.proto:61

  (message has no fields)

  message TimeoutResponse

  dnsplugin.proto:63

  • optional google.protobuf.Duration timeout = 1

  • optional google.protobuf.Duration interval = 2

• rpc IsSequential (IsSequentialRequest, IsSequentialResponse)

  dnsplugin.proto:34

  IsSequential probes the plugin to see if it implements lego's internal sequential provider interfaces, which 1) indicates that it is a sequential provider (the presence of the interface means the provider is sequential) and 2) the duration of the interval between sequential queries. This is used to signal to the ACME provider's own wrappers what interface to present for the main plugin set.

  message IsSequentialRequest

  dnsplugin.proto:68

  (message has no fields)

  message IsSequentialResponse

  dnsplugin.proto:70

  • optional google.protobuf.Duration interval = 1

  • bool ok = 2