.\" Man page generated from reStructuredText.
.
.TH VMOD_PROXY 3 "" "" ""
.SH NAME
vmod_proxy \- Varnish Module to extract TLV attributes from PROXYv2
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" 
.
.\" NB:  This file is machine generated, DO NOT EDIT!
.
.\" 
.
.\" Edit ./vmod_proxy.vcc and run make instead
.
.\" 
.
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
import proxy [as name] [from "path"]

STRING alpn()

STRING authority()

BOOL is_ssl()

BOOL client_has_cert_sess()

BOOL client_has_cert_conn()

INT ssl_verify_result()

STRING ssl_version()

STRING client_cert_cn()

STRING ssl_cipher()

STRING cert_sign()

STRING cert_key()
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
\fIvmod_proxy\fP contains functions to extract proxy\-protocol\-v2 TLV
attributes as described in
\fI\%https://www.haproxy.org/download/1.8/doc/proxy\-protocol.txt\fP\&.
.SS STRING alpn()
.sp
Extract ALPN attribute.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set req.http.alpn = proxy.alpn();
.ft P
.fi
.UNINDENT
.UNINDENT
.SS STRING authority()
.sp
Extract authority attribute. This corresponds to SNI from a TLS
connection.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set req.http.authority = proxy.authority();
.ft P
.fi
.UNINDENT
.UNINDENT
.SS BOOL is_ssl()
.sp
Report if proxy\-protocol\-v2 has SSL TLV.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if (proxy.is_ssl()) {
        set req.http.ssl\-version = proxy.ssl_version();
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS BOOL client_has_cert_sess()
.sp
Report if the client provided a certificate at least once over the TLS
session this connection belongs to.
.SS BOOL client_has_cert_conn()
.sp
Report if the client provided a certificate over the current
connection.
.SS INT ssl_verify_result()
.sp
Report the SSL_get_verify_result from a TLS session. It only matters
if client_has_cert_sess() is true. Per default, value is set to 0
(X509_V_OK).
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
if (proxy.client_has_cert_sess() && proxy.ssl_verify_result() == 0) {
        set req.http.ssl\-verify = "ok";
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS STRING ssl_version()
.sp
Extract SSL version attribute.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set req.http.ssl\-version = proxy.ssl_version();
.ft P
.fi
.UNINDENT
.UNINDENT
.SS STRING client_cert_cn()
.sp
Extract the common name attribute of the client certificate\(aqs.
.INDENT 0.0
.TP
.B Example::
set req.http.cert\-cn = proxy.client_cert_cn();
.UNINDENT
.SS STRING ssl_cipher()
.sp
Extract the SSL cipher attribute.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set req.http.ssl\-cipher = proxy.ssl_cipher();
.ft P
.fi
.UNINDENT
.UNINDENT
.SS STRING cert_sign()
.sp
Extract the certificate signature algorithm attribute.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set req.http.cert\-sign = proxy.cert_sign();
.ft P
.fi
.UNINDENT
.UNINDENT
.SS STRING cert_key()
.sp
Extract the certificate key algorithm attribute.
.sp
Example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
set req.http.cert\-key = proxy.cert_key();
.ft P
.fi
.UNINDENT
.UNINDENT
.SH SEE ALSO
.INDENT 0.0
.IP \(bu 2
\fIvarnishd(1)\fP
.IP \(bu 2
\fIvsl(7)\fP
.UNINDENT
.SH COPYRIGHT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
Copyright (c) 2018 GANDI SAS
All rights reserved.

Author: Emmanuel Hocdet <manu@gandi.net>

SPDX\-License\-Identifier: BSD\-2\-Clause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS \(ga\(gaAS IS\(aq\(aq AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.ft P
.fi
.UNINDENT
.UNINDENT
.\" Generated by docutils manpage writer.
.