File: _stackmanager.8.xml

package info (click to toggle)
libreswan 4.3-1%2Bdeb11u4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 62,688 kB
  • sloc: ansic: 108,293; sh: 25,973; xml: 11,756; python: 10,230; makefile: 1,580; javascript: 1,353; yacc: 825; sed: 647; perl: 584; lex: 159; awk: 156
file content (75 lines) | stat: -rw-r--r-- 3,240 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry>
<refentryinfo>
  <author><firstname>Paul</firstname><surname>Wouters</surname><authorblurb><para>placeholder to suppress warning</para> </authorblurb></author>
</refentryinfo>
<refmeta>
<refentrytitle>_STACKMANAGER</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class='date'>06 May 2019</refmiscinfo>
<refmiscinfo class="source">libreswan</refmiscinfo>
<refmiscinfo class="manual">Executable programs</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>ipsec _stackmanager</refname>
<refpurpose>internal script to bring up kernel components for Libreswan</refpurpose>
</refnamediv>
<!-- body begins here -->


  <refsynopsisdiv id="synopsis">

    <cmdsynopsis>
      <command>ipsec</command>
      <arg choice="plain"><replaceable>_stackmanager start</replaceable>
<arg choice="opt">--xfrm</arg></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>ipsec</command>
      <arg choice="plain"><replaceable>_stackmanager stop</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

<refsect1 id='description'><title>DESCRIPTION</title>
<para><emphasis remap='I'>ipsec _stackmanager</emphasis> is called
from within the init sub-system (systemd, upstart, sysv initscripts)
to bring up the Libreswan kernel component as configured via the
<emphasis remap='I'>protostack=</emphasis> option in the <emphasis
remap='I'>ipsec.conf</emphasis> configuration file.</para>

<para>This involves loading and optionally unloading of the required
kernel modules. Because the Linux kernel cannot autodetect most crypto
related drivers on-demand, _stackmanager handles loading the modules
for the specific IPsec stack.
</para>
<para>When the --xfrm option is given to the start command, the XFRM stack
is loaded regardless of the existence or contents of the ipsec.conf file.
This is used for docker tests where the host system, which might not have
libreswan installed, needs to run _stackmanager from the source tree to load
the modules on the host so the modules are available inside
the containers.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec_tncfg</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>ipsec_addconn</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>pluto</refentrytitle><manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>

<refsect1 id='history'><title>HISTORY</title>
<para>This script was introduced in Libreswan. On the older Openswan systems, this functionality was split
over various script files such as ipsec _startnetkey, ipsec _startklips, ipsec _realsetup and ipsec setup.
Man page written for the Libreswan project &lt;<ulink url='https://libreswan.org/'>https://libreswan.org/</ulink>&gt;
by Paul Wouters. </para>

</refsect1>
</refentry>