src/PVE/ACME/Challenge.pm

   1 package PVE::ACME::Challenge;
   2
   3 use strict;
   4 use warnings;
   5
   6 use PVE::JSONSchema qw(get_standard_option);
   7
   8 use base qw(PVE::SectionConfig);
   9
  10 my $defaultData = {
  11     additionalProperties => 0,
  12     propertyList => {
  13         id => {
  14             description => "ACME Plugin ID name",
  15             type => 'string',
  16         },
  17         type => {
  18             description => "ACME challenge type.",
  19             type => 'string',
  20         },
  21         disable => {
  22             description => "Flag to disable the config.",
  23             type => 'boolean',
  24             optional => 1,
  25         },
  26         nodes => get_standard_option('pve-node-list', { optional => 1 }),
  27     },
  28 };
  29
  30 sub private {
  31     return $defaultData;
  32 }
  33
  34 sub parse_config {
  35     my ($class, $filename, $raw) = @_;
  36
  37     my $cfg = $class->SUPER::parse_config($filename, $raw);
  38     my $ids = $cfg->{ids};
  39
  40     # make sure we have a standalone plugin definition as fallback!
  41     if (!$ids->{standalone} || $ids->{standalone}->{type} ne 'standalone') {
  42         $ids->{standalone} = {
  43             type => 'standalone',
  44         };
  45     }
  46
  47     return $cfg;
  48 }
  49
  50 sub supported_challenge_types {
  51     return [];
  52 }
  53
  54 sub extract_challenge {
  55     my ($self, $challenges) = @_;
  56
  57     die "no challenges defined\n" if !$challenges;
  58
  59     my $supported_types = $self->supported_challenge_types();
  60
  61     # preference returned by plugin!
  62     foreach my $supported_type (@$supported_types) {
  63         foreach my $challenge (@$challenges) {
  64             next if $challenge->{type} ne $supported_type;
  65
  66             return $challenge;
  67         }
  68     }
  69
  70     die "plugin does not support any of the requested challenge types\n";
  71 }
  72
  73 sub get_subplugins {
  74     return [];
  75 }
  76
  77 # acme => PVE::ACME instance
  78 # auth => authorization object returned by ACME server
  79 # $data => {
  80 #   plugin => plugin config data
  81 #   alias => optional domain alias
  82 # }
  83 # needs to set $data->{url} to URL of the challenge which has been set up
  84 # can set other $data keys needed by teardown sub
  85 sub setup {
  86     my ($self, $acme, $auth, $data) = @_;
  87
  88     die "implement me\n";
  89 }
  90
  91 # see setup
  92 sub teardown {
  93     my ($self, $acme, $auth, $data) = @_;
  94
  95     die "implement me\n";
  96 }
  97
  98 1;