gen-pmg.conf.5-opts.pl

   1 #!/usr/bin/perl
   2
   3 use lib '.';
   4 use strict;
   5 use warnings;
   6 use PVE::RESTHandler;
   7
   8 use Data::Dumper;
   9
  10 use PMG::Config;
  11
  12 my $types = PMG::Config::Base->lookup_types;
  13
  14 my $single_section = shift;
  15 my $found = 0;
  16
  17 my $skiped_keys = {
  18     'delete' => 1,
  19     digest => 1,
  20 };
  21
  22 my $key_groups = {
  23     'mail-options' => [
  24         'mail' , {
  25             maxsize => 1,
  26             rejectunknown => 1,
  27             rejectunknownsender => 1,
  28             helotests => 1,
  29             dnsbl_sites => 1,
  30             dnsbl_threshold => 1,
  31             verifyreceivers => 1,
  32             greylist => 1,
  33             spf => 1,
  34             hide_received => 1,
  35             dwarning => 1,
  36             conn_count_limit => 1,
  37             conn_rate_limit => 1,
  38             message_rate_limit => 1,
  39             banner => 1,
  40         }],
  41     'mail-tls' => [
  42         'mail' , {
  43             tls => 1,
  44             tlsheader => 1,
  45             tlslog => 1,
  46         }],
  47     'mail-ports' => [
  48         'mail' , {
  49             int_port => 1,
  50             ext_port => 1,
  51         }],
  52     'mail-relaying' => [
  53         'mail' , {
  54             relay => 1,
  55             relaynomx => 1,
  56             relayport => 1,
  57             smarthost => 1,
  58             smarthostport => 1,
  59         }],
  60     'admin-dkim' => [
  61         'admin' , {
  62             dkim_selector => 1,
  63             dkim_sign => 1,
  64             dkim_sign_all_mail => 1,
  65         }],
  66 };
  67
  68 if (1) {
  69     # verify if we document all mail settings
  70     my $plugin = PMG::Config::Base->lookup('mail');
  71     my $schema = $plugin->updateSchema(1);
  72     my $properties = $schema->{properties};
  73
  74     my $found_mail_keys = {};
  75     foreach my $group (keys %$key_groups) {
  76         my ($sec, $hash) = @{$key_groups->{$group}};
  77         next if $sec ne 'mail';
  78         foreach my $k (keys %$hash) {
  79             die "unknown key '$k'" if !defined($properties->{$k});
  80             $found_mail_keys->{$k} = 1;
  81         }
  82     }
  83     foreach my $k (keys %$properties) {
  84         next if $skiped_keys->{$k};
  85         next if $k =~ m/^max_(filters|policy|smtpd_in|smtpd_out)$/;
  86         die "undocumented key '$k'" if !defined($found_mail_keys->{$k});
  87     }
  88 }
  89
  90
  91 my $select_keys;
  92
  93 if ($single_section) {
  94     if (my $a =  $key_groups->{$single_section}) {
  95         my ($sec, $hash) = @$a;
  96         $single_section = $sec;
  97         $select_keys = $hash;
  98     }
  99 }
 100
 101
 102 foreach my $section (@$types) {
 103     my $plugin = PMG::Config::Base->lookup($section);
 104     my $schema = $plugin->updateSchema(1);
 105     my $properties = $schema->{properties};
 106
 107     if (defined($single_section)) {
 108         next if $section ne $single_section;
 109     } else {
 110         print ".Section '$section'\n\n";
 111     }
 112
 113     $found = 1;
 114
 115     my $filter = sub {
 116         my ($key, $phash) = @_;
 117         return 1 if $skiped_keys->{$key};
 118         return 1 if $select_keys && !$select_keys->{$key};
 119         return 0;
 120     };
 121
 122     print PVE::RESTHandler::dump_properties(
 123         $properties, 'asciidoc', 'config', $filter);
 124 }
 125
 126 if (defined($single_section)) {
 127     die "no such section '$single_section'" if !$found;
 128 }
 129
 130 exit(0);