[pmg-api.git] / src / PMG / Service / pmgproxy.pm

package PMG::Service::pmgproxy;

use strict;
use warnings;

use PVE::SafeSyslog;
use PVE::Daemon;
use HTTP::Response;
use URI;
use URI::Escape;

use URI::QueryParam;
use Data::Dumper;

use PVE::Tools;
use PVE::APIServer::Formatter;
use PVE::APIServer::Formatter::Standard;
use PVE::APIServer::Formatter::HTML;
use PVE::APIServer::AnyEvent;
use PVE::APIServer::Utils;

use PMG::HTTPServer;
use PMG::API2;
use PMG::Config;

use Template;

use base qw(PVE::Daemon);

my $cmdline = [$0, @ARGV];

my %daemon_options = (
    max_workers => 3,
    restart_on_error => 5,
    stop_wait_time => 15,
    leave_children_open_on_reload => 1,
    setuid => 'www-data',
    setgid => 'www-data',
    pidfile => '/run/pmgproxy/pmgproxy.pid',
);

my $daemon = __PACKAGE__->new('pmgproxy', $cmdline, %daemon_options);

sub add_dirs {
    my ($result_hash, $alias, $subdir) = @_;

    PVE::APIServer::AnyEvent::add_dirs($result_hash, $alias, $subdir);
}

my $gui_base_dir = "/usr/share/javascript/pmg-gui";
my $extjs_dir = "/usr/share/javascript/extjs/";
my $fontawesome_dir = "/usr/share/fonts-font-awesome";
my $xtermjs_dir = '/usr/share/pve-xtermjs';
my $framework7_dir = '/usr/share/javascript/framework7';
my $widgettoolkit_dir = '/usr/share/javascript/proxmox-widget-toolkit';

sub init {
    my ($self) = @_;

    my $proxyconf = PVE::APIServer::Utils::read_proxy_config($self->{name});

    my $accept_lock_fn = "/var/lock/pmgproxy.lck";

    my $lockfh = IO::File->new(">>${accept_lock_fn}") ||
	die "unable to open lock file '${accept_lock_fn}' - $!\n";

    my $listen_ip = $proxyconf->{LISTEN_IP};
    my $socket = $self->create_reusable_socket(8006, $listen_ip);

    my $dirs = {};

    add_dirs($dirs, '/pve2/locale/', '/usr/share/pmg-i18n/');
    add_dirs($dirs, '/pve2/ext6/', $extjs_dir);
    add_dirs($dirs, '/pve2/images/' => "$gui_base_dir/images/");
    add_dirs($dirs, '/pve2/css/' => "$gui_base_dir/css/");
    add_dirs($dirs, '/pve2/js/' => "$gui_base_dir/js/");
    add_dirs($dirs, '/fontawesome/css/' => "$fontawesome_dir/css/");
    add_dirs($dirs, '/fontawesome/fonts/' => "$fontawesome_dir/fonts/");
    add_dirs($dirs, '/framework7/fonts/' => "$framework7_dir/fonts/");
    add_dirs($dirs, '/framework7/css/' => "$framework7_dir/css/");
    add_dirs($dirs, '/framework7/js/' => "$framework7_dir/js/");
    add_dirs($dirs, '/xtermjs/' => "$xtermjs_dir/");
    add_dirs($dirs, '/pmg-docs/' => '/usr/share/pmg-docs/');
    add_dirs($dirs, '/pmg-docs/api-viewer/extjs/' => $extjs_dir);
    add_dirs($dirs, '/pwt/css/' => "$widgettoolkit_dir/css/");
    add_dirs($dirs, '/pwt/images/' =>  "$widgettoolkit_dir/images/");
    add_dirs($dirs, '/pwt/themes/' => "$widgettoolkit_dir/themes/");

    $self->{server_config} = {
	title => 'Proxmox Mail Gateway API',
	cookie_name => 'PMGAuthCookie',
	keep_alive => 100,
	max_conn => 500,
	max_requests => 1000,
	lockfile => $accept_lock_fn,
	socket => $socket,
	lockfh => $lockfh,
	debug => $self->{debug},
	trusted_env => 0, # not trusted, anyone can connect
	logfile => '/var/log/pmgproxy/pmgproxy.log',
	allow_from => $proxyconf->{ALLOW_FROM},
	deny_from => $proxyconf->{DENY_FROM},
	policy => $proxyconf->{POLICY},
	ssl => {
	    cert_file => '/etc/pmg/pmg-api.pem',
	    dh => 'skip2048',
	    cipher_list => $proxyconf->{CIPHERS},
	    ciphersuites => $proxyconf->{CIPHERSUITES},
	    honor_cipher_order => $proxyconf->{HONOR_CIPHER_ORDER},
	},
	compression => $proxyconf->{COMPRESSION},
	# Note: there is no authentication for those pages and dirs!
	pages => {
	    '/' => sub { get_index($self->{nodename}, @_) },
	    '/quarantine' => sub { get_index($self->{nodename}, @_) },
	    # avoid authentication when accessing favicon
	    '/favicon.ico' => {
		file => '/usr/share/doc/pmg-api/favicon.ico',
	    },
	    '/proxmoxlib.js' => {
		file => '/usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js',
	    },
	    '/qrcode.min.js' => {
		file => '/usr/share/javascript/qrcodejs/qrcode.min.js',
	    },
	},
	dirs => $dirs,
    };

    if (defined($proxyconf->{DHPARAMS})) {
	$self->{server_config}->{ssl}->{dh_file} = $proxyconf->{DHPARAMS};
    }
    if (defined($proxyconf->{DISABLE_TLS_1_2})) {
	$self->{server_config}->{ssl}->{tlsv1_2} = !$proxyconf->{DISABLE_TLS_1_2};
    }
    if (defined($proxyconf->{DISABLE_TLS_1_3})) {
	$self->{server_config}->{ssl}->{tlsv1_3} = !$proxyconf->{DISABLE_TLS_1_3};
    }
}

sub run {
    my ($self) = @_;

    my $server = PMG::HTTPServer->new(%{$self->{server_config}});
    $server->run();
}

$daemon->register_start_command();
$daemon->register_restart_command(1);
$daemon->register_stop_command();
$daemon->register_status_command();

our $cmddef = {
    start => [ __PACKAGE__, 'start', []],
    restart => [ __PACKAGE__, 'restart', []],
    stop => [ __PACKAGE__, 'stop', []],
    status => [ __PACKAGE__, 'status', [], undef, sub { print shift . "\n";} ],
};

my $template_toolkit;

sub get_template_toolkit {

    return $template_toolkit if $template_toolkit;

    $template_toolkit = Template->new(
	{ INCLUDE_PATH => [$gui_base_dir, $xtermjs_dir]});

    return $template_toolkit;
}

sub is_phone {
    my ($ua) = @_;

    return 0 if !$ua;

    if ($ua =~ m/(
	iPhone|
	iPod|
	Windows\ Phone|
	Android|
	BlackBerry
	)/xi) {
	return 1;
    }

    return 0;
}

sub get_index {
    my ($nodename, $server, $r, $args) = @_;

    my $lang = 'en';
    my $username;
    my $token = 'null';
    my $quarantine = ($r->uri->path() =~ m/quarantine$/);
    my $mobile = is_phone($r->header('User-Agent'));
    if (defined($args->{mobile})) {
	$mobile = $args->{mobile} ? 1 : 0;
    }

    my $theme = "";

    if (my $cookie = $r->header('Cookie')) {
	if (my $newlang = ($cookie =~ /(?:^|\s)PMGLangCookie=([^;]*)/)[0]) {
	    if ($newlang =~ m/^[a-z]{2,3}(_[A-Z]{2,3})?$/) {
		$lang = $newlang;
	    }
	}

	if (my $newtheme = ($cookie =~ /(?:^|\s)PMGThemeCookie=([^;]*)/)[0]) {
	    # theme names need to be kebab case, with each segment a maximum of 10 characters long
	    # and at most 6 segments
	    if ($newtheme =~ m/^[a-z]{1,10}(-[a-z]{1,10}){0,5}$/) {
		$theme = $newtheme;
	    }
	}

	my $ticket = PVE::APIServer::Formatter::extract_auth_value($cookie, $server->{cookie_name});

	if ($ticket =~ m/^PMGQUAR:/) {
	    $username = PMG::Ticket::verify_quarantine_ticket($ticket, 1);
	} else {
	    $username = PMG::Ticket::verify_ticket($ticket, undef, 1);
	}
    } else {
	if (defined($args->{ticket})) {
	    my $ticket = uri_unescape($args->{ticket});
	    $username = PMG::Ticket::verify_quarantine_ticket($ticket, 1);
	}
    }

    if ($theme eq "") {
	$theme = "auto"
    }

    $token = PMG::Ticket::assemble_csrf_prevention_token($username)
	if defined($username);

    my $langfile = 0;

    if (-f  "/usr/share/pmg-i18n/pmg-lang-$lang.js") {
	$langfile = 1;
    }

    my $wtversionraw = PVE::Tools::file_read_firstline("$widgettoolkit_dir/proxmoxlib.js");
    my $wtversion = '';
    if ($wtversionraw =~ m|^// (.*)$|) {
	$wtversion = $1;
    };

    my $versionraw = PVE::Tools::file_read_firstline("$gui_base_dir/js/pmgmanagerlib.js");
    my $version = '';
    if ($versionraw =~ m|^// (.*)$|) {
	$version = $1;
    };

    my $cfg = PMG::Config->new();
    my $quarantinelink = $cfg->get('spamquar', 'quarantinelink');

    $username = '' if !$username;

    my $page = '';

    my $vars = {
	lang => $lang,
	langfile => $langfile,
	username => $username,
	token => $token,
	console => $args->{console},
	nodename => $nodename,
	debug => $args->{debug} || $server->{debug},
	version => $version,
	wtversion => $wtversion,
	quarantinelink => $quarantinelink,
	theme => $theme,
    };

    my $template_name;
    if (defined($args->{console}) && $args->{xtermjs}) {
	$template_name = "index.html.tpl"; # fixme: use better name
    } elsif ($mobile && $quarantine) {
	$template_name = "pmg-mobile-index.html.tt";
    } else {
	$template_name = "pmg-index.html.tt";
    }

    my $tt = get_template_toolkit();

    $tt->process($template_name, $vars, \$page) ||
	die $tt->error() . "\n";

    my $headers = HTTP::Headers->new(Content_Type => "text/html; charset=utf-8");
    my $resp = HTTP::Response->new(200, "OK", $headers, $page);

    return $resp;
}

1;
Commit	Line	Data
0854fb22 DM	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;
614ee52d DM	10	use URI::Escape;
614ee52d DM	11
0854fb22 DM	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;
e617af3f	20	use PVE::APIServer::Utils;
0854fb22 DM	21
	22	use PMG::HTTPServer;
	23	use PMG::API2;
f9fb1781	24	use PMG::Config;
0854fb22	25
803b4163	26	use Template;
0854fb22 DM	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',
83e9f427	39	pidfile => '/run/pmgproxy/pmgproxy.pid',
0854fb22 DM	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
572ff727	50	my $gui_base_dir = "/usr/share/javascript/pmg-gui";
6fcf7afb	51	my $extjs_dir = "/usr/share/javascript/extjs/";
61ab886a	52	my $fontawesome_dir = "/usr/share/fonts-font-awesome";
6466cf6d	53	my $xtermjs_dir = '/usr/share/pve-xtermjs';
9adf84b5	54	my $framework7_dir = '/usr/share/javascript/framework7';
a0de78bd	55	my $widgettoolkit_dir = '/usr/share/javascript/proxmox-widget-toolkit';
803b4163	56
0854fb22 DM	57	sub init {
	58	my ($self) = @_;
	59
e617af3f SI	60	my $proxyconf = PVE::APIServer::Utils::read_proxy_config($self->{name});
e617af3f SI	61
0854fb22 DM	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
cc7fa1b8 OB	67	my $listen_ip = $proxyconf->{LISTEN_IP};
cc7fa1b8 OB	68	my $socket = $self->create_reusable_socket(8006, $listen_ip);
0854fb22 DM	69
	70	my $dirs = {};
	71
7e7cdb14	72	add_dirs($dirs, '/pve2/locale/', '/usr/share/pmg-i18n/');
6fcf7afb	73	add_dirs($dirs, '/pve2/ext6/', $extjs_dir);
803b4163 DM	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/");
2ec2c08a DM	77	add_dirs($dirs, '/fontawesome/css/' => "$fontawesome_dir/css/");
2ec2c08a DM	78	add_dirs($dirs, '/fontawesome/fonts/' => "$fontawesome_dir/fonts/");
9adf84b5 DC	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/");
6466cf6d	82	add_dirs($dirs, '/xtermjs/' => "$xtermjs_dir/");
87546b89	83	add_dirs($dirs, '/pmg-docs/' => '/usr/share/pmg-docs/');
6fcf7afb	84	add_dirs($dirs, '/pmg-docs/api-viewer/extjs/' => $extjs_dir);
a0de78bd	85	add_dirs($dirs, '/pwt/css/' => "$widgettoolkit_dir/css/");
6d0af4a5 SS	86	add_dirs($dirs, '/pwt/images/' => "$widgettoolkit_dir/images/");
6d0af4a5 SS	87	add_dirs($dirs, '/pwt/themes/' => "$widgettoolkit_dir/themes/");
0854fb22 DM	88
	89	$self->{server_config} = {
	90	title => 'Proxmox Mail Gateway API',
2ec2c08a	91	cookie_name => 'PMGAuthCookie',
0854fb22 DM	92	keep_alive => 100,
	93	max_conn => 500,
	94	max_requests => 1000,
	95	lockfile => $accept_lock_fn,
	96	socket => $socket,
	97	lockfh => $lockfh,
	98	debug => $self->{debug},
	99	trusted_env => 0, # not trusted, anyone can connect
	100	logfile => '/var/log/pmgproxy/pmgproxy.log',
e617af3f SI	101	allow_from => $proxyconf->{ALLOW_FROM},
	102	deny_from => $proxyconf->{DENY_FROM},
	103	policy => $proxyconf->{POLICY},
0854fb22	104	ssl => {
3278b571	105	cert_file => '/etc/pmg/pmg-api.pem',
0854fb22	106	dh => 'skip2048',
e617af3f	107	cipher_list => $proxyconf->{CIPHERS},
387cc196	108	ciphersuites => $proxyconf->{CIPHERSUITES},
e617af3f	109	honor_cipher_order => $proxyconf->{HONOR_CIPHER_ORDER},
0854fb22	110	},
e617af3f	111	compression => $proxyconf->{COMPRESSION},
0854fb22 DM	112	# Note: there is no authentication for those pages and dirs!
	113	pages => {
	114	'/' => sub { get_index($self->{nodename}, @_) },
614ee52d	115	'/quarantine' => sub { get_index($self->{nodename}, @_) },
0854fb22	116	# avoid authentication when accessing favicon
cb159468	117	'/favicon.ico' => {
572ff727	118	file => '/usr/share/doc/pmg-api/favicon.ico',
cb159468	119	},
bbcc9ce6 DM	120	'/proxmoxlib.js' => {
	121	file => '/usr/share/javascript/proxmox-widget-toolkit/proxmoxlib.js',
	122	},
0a462c62 WB	123	'/qrcode.min.js' => {
	124	file => '/usr/share/javascript/qrcodejs/qrcode.min.js',
	125	},
0854fb22 DM	126	},
	127	dirs => $dirs,
	128	};
e617af3f SI	129
	130	if (defined($proxyconf->{DHPARAMS})) {
	131	$self->{server_config}->{ssl}->{dh_file} = $proxyconf->{DHPARAMS};
	132	}
41a97dc6 FG	133	if (defined($proxyconf->{DISABLE_TLS_1_2})) {
	134	$self->{server_config}->{ssl}->{tlsv1_2} = !$proxyconf->{DISABLE_TLS_1_2};
	135	}
	136	if (defined($proxyconf->{DISABLE_TLS_1_3})) {
	137	$self->{server_config}->{ssl}->{tlsv1_3} = !$proxyconf->{DISABLE_TLS_1_3};
	138	}
0854fb22 DM	139	}
	140
	141	sub run {
	142	my ($self) = @_;
	143
	144	my $server = PMG::HTTPServer->new(%{$self->{server_config}});
	145	$server->run();
	146	}
	147
	148	$daemon->register_start_command();
	149	$daemon->register_restart_command(1);
	150	$daemon->register_stop_command();
	151	$daemon->register_status_command();
	152
	153	our $cmddef = {
	154	start => [ __PACKAGE__, 'start', []],
	155	restart => [ __PACKAGE__, 'restart', []],
	156	stop => [ __PACKAGE__, 'stop', []],
	157	status => [ __PACKAGE__, 'status', [], undef, sub { print shift . "\n";} ],
	158	};
	159
9ff4a97a DM	160	my $template_toolkit;
	161
	162	sub get_template_toolkit {
	163
	164	return $template_toolkit if $template_toolkit;
	165
	166	$template_toolkit = Template->new(
6466cf6d	167	{ INCLUDE_PATH => [$gui_base_dir, $xtermjs_dir]});
9ff4a97a DM	168
	169	return $template_toolkit;
	170	}
	171
9adf84b5 DC	172	sub is_phone {
	173	my ($ua) = @_;
	174
	175	return 0 if !$ua;
	176
	177	if ($ua =~ m/(
	178	iPhone\|
	179	iPod\|
	180	Windows\ Phone\|
	181	Android\|
	182	BlackBerry
	183	)/xi) {
	184	return 1;
	185	}
	186
	187	return 0;
	188	}
	189
0854fb22 DM	190	sub get_index {
	191	my ($nodename, $server, $r, $args) = @_;
	192
	193	my $lang = 'en';
	194	my $username;
	195	my $token = 'null';
9adf84b5 DC	196	my $quarantine = ($r->uri->path() =~ m/quarantine$/);
	197	my $mobile = is_phone($r->header('User-Agent'));
	198	if (defined($args->{mobile})) {
	199	$mobile = $args->{mobile} ? 1 : 0;
	200	}
0854fb22	201
9bcad3e1	202	my $theme = "";
6d0af4a5	203
0854fb22 DM	204	if (my $cookie = $r->header('Cookie')) {
	205	if (my $newlang = ($cookie =~ /(?:^\|\s)PMGLangCookie=([^;]*)/)[0]) {
	206	if ($newlang =~ m/^[a-z]{2,3}(_[A-Z]{2,3})?$/) {
	207	$lang = $newlang;
	208	}
	209	}
6d0af4a5 SS	210
	211	if (my $newtheme = ($cookie =~ /(?:^\|\s)PMGThemeCookie=([^;]*)/)[0]) {
	212	# theme names need to be kebab case, with each segment a maximum of 10 characters long
	213	# and at most 6 segments
	214	if ($newtheme =~ m/^[a-z]{1,10}(-[a-z]{1,10}){0,5}$/) {
	215	$theme = $newtheme;
	216	}
	217	}
	218
14ebc02d	219	my $ticket = PVE::APIServer::Formatter::extract_auth_value($cookie, $server->{cookie_name});
614ee52d DM	220
	221	if ($ticket =~ m/^PMGQUAR:/) {
	222	$username = PMG::Ticket::verify_quarantine_ticket($ticket, 1);
	223	} else {
5accfdf2	224	$username = PMG::Ticket::verify_ticket($ticket, undef, 1);
614ee52d DM	225	}
	226	} else {
	227	if (defined($args->{ticket})) {
	228	my $ticket = uri_unescape($args->{ticket});
	229	$username = PMG::Ticket::verify_quarantine_ticket($ticket, 1);
0854fb22 DM	230	}
	231	}
	232
8b0adf1c SS	233	if ($theme eq "") {
	234	$theme = "auto"
	235	}
	236
614ee52d DM	237	$token = PMG::Ticket::assemble_csrf_prevention_token($username)
	238	if defined($username);
	239
7e7cdb14 DM	240	my $langfile = 0;
	241
	242	if (-f "/usr/share/pmg-i18n/pmg-lang-$lang.js") {
	243	$langfile = 1;
	244	}
78c58e58	245
3fb6d663 DC	246	my $wtversionraw = PVE::Tools::file_read_firstline("$widgettoolkit_dir/proxmoxlib.js");
	247	my $wtversion = '';
	248	if ($wtversionraw =~ m\|^// (.*)$\|) {
	249	$wtversion = $1;
	250	};
	251
	252	my $versionraw = PVE::Tools::file_read_firstline("$gui_base_dir/js/pmgmanagerlib.js");
	253	my $version = '';
	254	if ($versionraw =~ m\|^// (.*)$\|) {
	255	$version = $1;
	256	};
	257
f9fb1781 DC	258	my $cfg = PMG::Config->new();
f9fb1781 DC	259	my $quarantinelink = $cfg->get('spamquar', 'quarantinelink');
3fb6d663	260
0854fb22 DM	261	$username = '' if !$username;
0854fb22 DM	262
803b4163 DM	263	my $page = '';
803b4163 DM	264
78c58e58 DM	265	my $vars = {
	266	lang => $lang,
	267	langfile => $langfile,
	268	username => $username,
	269	token => $token,
	270	console => $args->{console},
	271	nodename => $nodename,
	272	debug => $args->{debug} \|\| $server->{debug},
3fb6d663 DC	273	version => $version,
3fb6d663 DC	274	wtversion => $wtversion,
f9fb1781	275	quarantinelink => $quarantinelink,
6d0af4a5	276	theme => $theme,
78c58e58 DM	277	};
78c58e58 DM	278
9ff4a97a	279	my $template_name;
6466cf6d	280	if (defined($args->{console}) && $args->{xtermjs}) {
9ff4a97a	281	$template_name = "index.html.tpl"; # fixme: use better name
9adf84b5 DC	282	} elsif ($mobile && $quarantine) {
9adf84b5 DC	283	$template_name = "pmg-mobile-index.html.tt";
9ff4a97a DM	284	} else {
	285	$template_name = "pmg-index.html.tt";
	286	}
	287
	288	my $tt = get_template_toolkit();
	289
	290	$tt->process($template_name, $vars, \$page) \|\|
	291	die $tt->error() . "\n";
803b4163	292
0854fb22 DM	293	my $headers = HTTP::Headers->new(Content_Type => "text/html; charset=utf-8");
	294	my $resp = HTTP::Response->new(200, "OK", $headers, $page);
	295
	296	return $resp;
	297	}
	298
	299	1;