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             before_queue_filtering => 1,
  41             ndr_on_block => 1,
  42         }],
  43     'mail-tls' => [
  44         'mail' , {
  45             tls => 1,
  46             tlsheader => 1,
  47             tlslog => 1,
  48         }],
  49     'mail-ports' => [
  50         'mail' , {
  51             int_port => 1,
  52             ext_port => 1,
  53         }],
  54     'mail-relaying' => [
  55         'mail' , {
  56             relay => 1,
  57             relaynomx => 1,
  58             relayport => 1,
  59             smarthost => 1,
  60             smarthostport => 1,
  61         }],
  62     'admin-dkim' => [
  63         'admin' , {
  64             dkim_selector => 1,
  65             dkim_sign => 1,
  66             dkim_sign_all_mail => 1,
  67         }],
  68 };
  69
  70 if (1) {
  71     # verify if we document all mail settings
  72     my $plugin = PMG::Config::Base->lookup('mail');
  73     my $schema = $plugin->updateSchema(1);
  74     my $properties = $schema->{properties};
  75
  76     my $found_mail_keys = {};
  77     foreach my $group (keys %$key_groups) {
  78         my ($sec, $hash) = @{$key_groups->{$group}};
  79         next if $sec ne 'mail';
  80         foreach my $k (keys %$hash) {
  81             die "unknown key '$k'" if !defined($properties->{$k});
  82             $found_mail_keys->{$k} = 1;
  83         }
  84     }
  85     foreach my $k (keys %$properties) {
  86         next if $skiped_keys->{$k};
  87         next if $k =~ m/^max_(filters|policy|smtpd_in|smtpd_out)$/;
  88         die "undocumented key '$k'" if !defined($found_mail_keys->{$k});
  89     }
  90 }
  91
  92
  93 my $select_keys;
  94
  95 if ($single_section) {
  96     if (my $a =  $key_groups->{$single_section}) {
  97         my ($sec, $hash) = @$a;
  98         $single_section = $sec;
  99         $select_keys = $hash;
 100     }
 101 }
 102
 103
 104 foreach my $section (@$types) {
 105     my $plugin = PMG::Config::Base->lookup($section);
 106     my $schema = $plugin->updateSchema(1);
 107     my $properties = $schema->{properties};
 108
 109     if (defined($single_section)) {
 110         next if $section ne $single_section;
 111     } else {
 112         print ".Section '$section'\n\n";
 113     }
 114
 115     $found = 1;
 116
 117     my $filter = sub {
 118         my ($key, $phash) = @_;
 119         return 1 if $skiped_keys->{$key};
 120         return 1 if $select_keys && !$select_keys->{$key};
 121         return 0;
 122     };
 123
 124     print PVE::RESTHandler::dump_properties(
 125         $properties, 'asciidoc', 'config', $filter);
 126 }
 127
 128 if (defined($single_section)) {
 129     die "no such section '$single_section'" if !$found;
 130 }
 131
 132 exit(0);