src/PMG/Service/pmgproxy.pm

   1 package PMG::Service::pmgproxy;
   2
   3 use strict;
   4 use warnings;
   5
   6 use PVE::SafeSyslog;
   7 use PVE::Daemon;
   8 use HTTP::Response;
   9 use URI;
  10 use URI::Escape;
  11
  12 use URI::QueryParam;
  13 use Data::Dumper;
  14
  15 use PVE::Tools;
  16 use PVE::APIServer::Formatter;
  17 use PVE::APIServer::Formatter::Standard;
  18 use PVE::APIServer::Formatter::HTML;
  19 use PVE::APIServer::AnyEvent;
  20 use PVE::APIServer::Utils;
  21
  22 use PMG::HTTPServer;
  23 use PMG::API2;
  24 use PMG::Config;
  25
  26 use Template;
  27
  28 use base qw(PVE::Daemon);
  29
  30 my $cmdline = [$0, @ARGV];
  31
  32 my %daemon_options = (
  33     max_workers => 3,
  34     restart_on_error => 5,
  35     stop_wait_time => 15,
  36     leave_children_open_on_reload => 1,
  37     setuid => 'www-data',
  38     setgid => 'www-data',
  39     pidfile => '/run/pmgproxy/pmgproxy.pid',
  40 );
  41
  42 my $daemon = __PACKAGE__->new('pmgproxy', $cmdline, %daemon_options);
  43
  44 sub add_dirs {
  45     my ($result_hash, $alias, $subdir) = @_;
  46
  47     PVE::APIServer::AnyEvent::add_dirs($result_hash, $alias, $subdir);
  48 }
  49
  50 my $gui_base_dir = "/usr/share/javascript/pmg-gui";
  51 my $extjs_dir = "/usr/share/javascript/extjs/";
  52 my $fontawesome_dir = "/usr/share/fonts-font-awesome";
  53 my $xtermjs_dir = '/usr/share/pve-xtermjs';
  54 my $framework7_dir = '/usr/share/javascript/framework7';
  55 my $widgettoolkit_dir = '/usr/share/javascript/proxmox-widget-toolkit';
  56
  57 sub init {
  58     my ($self) = @_;
  59
  60     my $proxyconf = PVE::APIServer::Utils::read_proxy_config($self->{name});
  61
  62     my $accept_lock_fn = "/var/lock/pmgproxy.lck";
  63
  64     my $lockfh = IO::File->new(">>${accept_lock_fn}") ||
  65         die "unable to open lock file '${accept_lock_fn}' - $!\n";
  66
  67     my $listen_ip = $proxyconf->{LISTEN_IP};
  68     my $socket = $self->create_reusable_socket(8006, $listen_ip);
  69
  70     my $dirs = {};
  71
  72     add_dirs($dirs, '/pve2/locale/', '/usr/share/pmg-i18n/');
  73     add_dirs($dirs, '/pve2/ext6/', $extjs_dir);
  74     add_dirs($dirs, '/pve2/images/' => "$gui_base_dir/images/");
  75     add_dirs($dirs, '/pve2/css/' => "$gui_base_dir/css/");
  76     add_dirs($dirs, '/pve2/js/' => "$gui_base_dir/js/");
  77     add_dirs($dirs, '/fontawesome/css/' => "$fontawesome_dir/css/");
  78     add_dirs($dirs, '/fontawesome/fonts/' => "$fontawesome_dir/fonts/");
  79     add_dirs($dirs, '/framework7/fonts/' => "$framework7_dir/fonts/");
  80     add_dirs($dirs, '/framework7/css/' => "$framework7_dir/css/");
  81     add_dirs($dirs, '/framework7/js/' => "$framework7_dir/js/");
  82     add_dirs($dirs, '/xtermjs/' => "$xtermjs_dir/");
  83     add_dirs($dirs, '/pmg-docs/' => '/usr/share/pmg-docs/');
  84     add_dirs($dirs, '/pmg-docs/api-viewer/extjs/' => $extjs_dir);
  85     add_dirs($dirs, '/pwt/css/' => "$widgettoolkit_dir/css/");
  86     add_dirs($dirs, '/pwt/images/' => "$widgettoolkit_dir/images/");
  87
  88     $self->{server_config} = {
  89         title => 'Proxmox Mail Gateway API',
  90         cookie_name => 'PMGAuthCookie',
  91         keep_alive => 100,
  92         max_conn => 500,
  93         max_requests => 1000,
  94         lockfile => $accept_lock_fn,
  95         socket => $socket,
  96         lockfh => $lockfh,
  97         debug => $self->{debug},
  98         trusted_env => 0, # not trusted, anyone can connect
  99         logfile => '/var/log/pmgproxy/pmgproxy.log',
 100         allow_from => $proxyconf->{ALLOW_FROM},
 101         deny_from => $proxyconf->{DENY_FROM},
 102         policy => $proxyconf->{POLICY},
 103         ssl => {
 104             cert_file => '/etc/pmg/pmg-api.pem',
 105             dh => 'skip2048',
 106             cipher_list => $proxyconf->{CIPHERS},
 107             honor_cipher_order => $proxyconf->{HONOR_CIPHER_ORDER},
 108         },
 109         compression => $proxyconf->{COMPRESSION},
 110         # Note: there is no authentication for those pages and dirs!
 111         pages => {
 112             '/' => sub { get_index($self->{nodename}, @_) },
 113             '/quarantine' => sub { get_index($self->{nodename}, @_) },
 114             # avoid authentication when accessing favicon
 115             '/favicon.ico' => {
 116                 file => '/usr/share/doc/pmg-api/favicon.ico',
 117             },
 118             '/proxmoxlib.js' => {
 119                 file => '/usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js',
 120             },
 121         },
 122         dirs => $dirs,
 123     };
 124
 125     if (defined($proxyconf->{DHPARAMS})) {
 126         $self->{server_config}->{ssl}->{dh_file} = $proxyconf->{DHPARAMS};
 127     }
 128 }
 129
 130 sub run {
 131     my ($self) = @_;
 132
 133     my $server = PMG::HTTPServer->new(%{$self->{server_config}});
 134     $server->run();
 135 }
 136
 137 $daemon->register_start_command();
 138 $daemon->register_restart_command(1);
 139 $daemon->register_stop_command();
 140 $daemon->register_status_command();
 141
 142 our $cmddef = {
 143     start => [ __PACKAGE__, 'start', []],
 144     restart => [ __PACKAGE__, 'restart', []],
 145     stop => [ __PACKAGE__, 'stop', []],
 146     status => [ __PACKAGE__, 'status', [], undef, sub { print shift . "\n";} ],
 147 };
 148
 149 my $template_toolkit;
 150
 151 sub get_template_toolkit {
 152
 153     return $template_toolkit if $template_toolkit;
 154
 155     $template_toolkit = Template->new(
 156         { INCLUDE_PATH => [$gui_base_dir, $xtermjs_dir]});
 157
 158     return $template_toolkit;
 159 }
 160
 161 sub is_phone {
 162     my ($ua) = @_;
 163
 164     return 0 if !$ua;
 165
 166     if ($ua =~ m/(
 167         iPhone|
 168         iPod|
 169         Windows\ Phone|
 170         Android|
 171         BlackBerry
 172         )/xi) {
 173         return 1;
 174     }
 175
 176     return 0;
 177 }
 178
 179 sub get_index {
 180     my ($nodename, $server, $r, $args) = @_;
 181
 182     my $lang = 'en';
 183     my $username;
 184     my $token = 'null';
 185     my $quarantine = ($r->uri->path() =~ m/quarantine$/);
 186     my $mobile = is_phone($r->header('User-Agent'));
 187     if (defined($args->{mobile})) {
 188         $mobile = $args->{mobile} ? 1 : 0;
 189     }
 190
 191     if (my $cookie = $r->header('Cookie')) {
 192         if (my $newlang = ($cookie =~ /(?:^|\s)PMGLangCookie=([^;]*)/)[0]) {
 193             if ($newlang =~ m/^[a-z]{2,3}(_[A-Z]{2,3})?$/) {
 194                 $lang = $newlang;
 195             }
 196         }
 197         my $ticket = PVE::APIServer::Formatter::extract_auth_value($cookie, $server->{cookie_name});
 198
 199         if ($ticket =~ m/^PMGQUAR:/) {
 200             $username = PMG::Ticket::verify_quarantine_ticket($ticket, 1);
 201         } else {
 202             $username = PMG::Ticket::verify_ticket($ticket, undef, 1);
 203         }
 204     } else {
 205         if (defined($args->{ticket})) {
 206             my $ticket = uri_unescape($args->{ticket});
 207             $username = PMG::Ticket::verify_quarantine_ticket($ticket, 1);
 208         }
 209     }
 210
 211     $token = PMG::Ticket::assemble_csrf_prevention_token($username)
 212         if defined($username);
 213
 214     my $langfile = 0;
 215
 216     if (-f  "/usr/share/pmg-i18n/pmg-lang-$lang.js") {
 217         $langfile = 1;
 218     }
 219
 220     my $wtversionraw = PVE::Tools::file_read_firstline("$widgettoolkit_dir/proxmoxlib.js");
 221     my $wtversion = '';
 222     if ($wtversionraw =~ m|^// (.*)$|) {
 223         $wtversion = $1;
 224     };
 225
 226     my $versionraw = PVE::Tools::file_read_firstline("$gui_base_dir/js/pmgmanagerlib.js");
 227     my $version = '';
 228     if ($versionraw =~ m|^// (.*)$|) {
 229         $version = $1;
 230     };
 231
 232     my $cfg = PMG::Config->new();
 233     my $quarantinelink = $cfg->get('spamquar', 'quarantinelink');
 234
 235     $username = '' if !$username;
 236
 237     my $page = '';
 238
 239     my $vars = {
 240         lang => $lang,
 241         langfile => $langfile,
 242         username => $username,
 243         token => $token,
 244         console => $args->{console},
 245         nodename => $nodename,
 246         debug => $args->{debug} || $server->{debug},
 247         version => $version,
 248         wtversion => $wtversion,
 249         quarantinelink => $quarantinelink,
 250     };
 251
 252     my $template_name;
 253     if (defined($args->{console}) && $args->{xtermjs}) {
 254         $template_name = "index.html.tpl"; # fixme: use better name
 255     } elsif ($mobile && $quarantine) {
 256         $template_name = "pmg-mobile-index.html.tt";
 257     } else {
 258         $template_name = "pmg-index.html.tt";
 259     }
 260
 261     my $tt = get_template_toolkit();
 262
 263     $tt->process($template_name, $vars, \$page) ||
 264         die $tt->error() . "\n";
 265
 266     my $headers = HTTP::Headers->new(Content_Type => "text/html; charset=utf-8");
 267     my $resp = HTTP::Response->new(200, "OK", $headers, $page);
 268
 269     return $resp;
 270 }
 271
 272 1;