File: ipsec-letsencrypt.8.xml

package info (click to toggle)
libreswan 5.2-2.3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 81,644 kB
  • sloc: ansic: 129,988; sh: 32,018; xml: 20,646; python: 10,303; makefile: 3,022; javascript: 1,506; sed: 574; yacc: 511; perl: 264; awk: 52
file content (111 lines) | stat: -rw-r--r-- 3,723 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
                   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry>
  <refmeta>
    <refentrytitle>IPSEC-LETSENCRYPT</refentrytitle>
    <manvolnum>8</manvolnum>
    <refmiscinfo class='date'>3 August 2019</refmiscinfo>
    <refmiscinfo class="source">Libreswan</refmiscinfo>
    <refmiscinfo class="version">@@IPSECVERSION@@</refmiscinfo>
    <refmiscinfo class="manual">Executable programs</refmiscinfo>
  </refmeta>
  <refnamediv id='name'>
    <refname>ipsec-letsencrypt</refname>
    <refpurpose>invoke Opportunistic Encryption utilities</refpurpose>
  </refnamediv>
  <!-- body begins here -->
  <refsynopsisdiv id='synopsis'>
    <cmdsynopsis>
      <command>ipsec letsencrypt</command>
      <arg choice='opt'>--client </arg>
      <arg choice='opt'>--server </arg>
      <arg choice='opt'>--test </arg>
      <arg choice='opt'>--disable </arg>
      <arg choice='opt'>--help </arg>
      <sbr/>
      <arg choice='opt'>--generate-certificate <replaceable>hostname</replaceable></arg>
      <arg choice='opt'>--renew <replaceable>hostname</replaceable></arg>
      <sbr/>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id='examples'>
    <title>EXAMPLES</title>
    <cmdsynopsis>
      <command>ipsec letsencrypt</command>
      <arg choice='plain'>{ --client | --server | --test | --disable | --help }</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>ipsec letsencrypt</command>
      <arg choice='plain'>{ --generate-certificate | --renew }</arg>
      <arg choice='plain'><replaceable>hostname</replaceable></arg>
    </cmdsynopsis>
  </refsect1>
  <refsect1 id='description'>
    <title>DESCRIPTION</title>
    <para>
      <emphasis>Letsencrypt</emphasis>
      The command creates a secure Opportunistic Connection between the hosts
      commonly referred to as client and server. The client connects to the server
      and remains anonymous, whereas the server is authenticated before connecting
      to it. The server is not anonymous. The server uses Let's Encrypt certificates
      for authentication and encryption purposes.
    </para>

    <para>
      The option <option>--client</option> is used for initial client
      setup.
    </para>

    <para>
      The option <option>--server</option> is used for initial server
      setup.
    </para>

    <para>
      The option <option>--test</option> is used for testing the
      configuration/connection.
    </para>

    <para>
      The option <option>--generate-certificate <replaceable>hostname</replaceable></option>
      is used for generating the certificate for the hostname.
    </para>

    <para>
      The option <option>--renew
      <replaceable>hostname</replaceable></option> is used for
      updating the generated certificate, it keeps the private key
      same.
    </para>

    <para>
      The option <option>--disable</option> is used for disabling
      IPsec service.
    </para>

    <para>
      The option <option>--help</option> is used for displaying all
      the available options.
    </para>
  </refsect1>
  <refsect1 id='see_also'>
    <title>SEE ALSO</title>
    <para>
      <citerefentry><refentrytitle>ipsec.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
    </para>
  </refsect1>
  <refsect1 id='history'>
    <title>HISTORY</title>
    <para>
      Original Program written by &lt;<ulink url='https://github.com/Rishabh04-02/'>Rishabh</ulink>&gt;.
    </para>
  </refsect1>
  <refsect1 id='author'>
    <title>AUTHOR</title>
    <para>
      <author><personname><firstname>Rishabh</firstname></personname></author>
    </para>
  </refsect1>
</refentry>