/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-options.xml

  • Committer: Teddy Hogeborn
  • Date: 2021-03-21 20:46:40 UTC
  • Revision ID: teddy@recompile.se-20210321204640-lpsyen8jr9lw1jma
Some cleanup of GnuTLS interface

Rename opaque internal GnuTLS structures named *_int to also start
with underscore (_), as is the custom in Python programs.

Decode byte strings from UTF-8 where needed.  (Fixing, among other
things, all "DEBUG: GnuTLS" lines having a "b'" prefix in Python 3.)

Simplify calling C functions by:
1. Using the "_as_parameter_" attribute to store the ctypes object.
2. Creating and using helper classes to automatically create pointers
   or cast typed pointers to pointers to void.
3. Providing the "from_param()" method on relevant classes.

Remove "restype" attribute on C functions where "errcheck" attribute
is already set.

* mandos (gnutls.session_int): Rename to start with "_".
  (gnutls.openpgp_crt_int): - '' -
  (gnutls.Error.__init__): Decode byte string from gnutls.strerror().
  (gnutls.PointerTo): New helper class.
  (gnutls.CastToVoidPointer): - '' -
  (gnutls.With_from_param): - '' -
  (gnutls.Credentials): Inherit from "With_from_param" and store the
  ctypes object in the "_as_parameter_" attribute instead of
  "_c_object".
  (gnutls._error_code): Use "gnutls.E_SUCCESS" instead of the unadorned
  numerical constant "0".
  (gnutls._retry_on_error): - '' -
  (gnutls.priority_set_direct.argtypes): Use "ClientSession" instead
  of "session_t", and change all callers to match.
  (gnutls.init.argtypes): Use "PointerTo(ClientSession)" instead of
  "ctypes.POINTER(session_t)", and change all callers to match.
  (gnutls.set_default_priority.argtypes): Use "ClientSession" instead
  of "session_t", and change all callers to match.
  (gnutls.record_send.argtypes): - '' -
  (gnutls.certificate_allocate_credentials.argtypes): Use
  "PointerTo(Credentials)" instead of
  "ctypes.POINTER(certificate_credentials_t)", and change all callers
  to match.
  (gnutls.certificate_free_credentials.argtypes): Use "Credentials"
  instead of "certificate_credentials_t", and change all callers to
  match.
  (gnutls.handshake_set_private_extensions.argtypes): Use
  "ClientSession" instead of "session_t", and change all callers to
  match.
  (gnutls.credentials_set.argtypes): Use
  "CastToVoidPointer(Credentials)" instead of "ctypes.c_void_p", and
  change all callers to match.
  (gnutls.certificate_type_get.argtypes): Use "ClientSession" instead
  of "session_t", and change all callers to match.
  (gnutls.certificate_get_peers.argtypes): - '' -
  (gnutls.deinit.argtypes): - '' -
  (gnutls.handshake.argtypes): - '' -
  (gnutls.handshake.restype): Change from "_error_code" to
  "ctypes.c_int".
  (gnutls.transport_set_ptr.argtypes): Use "ClientSession" instead of
  "session_t", and change all callers to match.
  (gnutls.bye.argtypes): - '' -
  (gnutls.bye.restype): Change from "_error_code" to "ctypes.c_int".
  (gnutls.certificate_type_get2.argtypes): Use "ClientSession" instead
  of "session_t", and change all callers to match.
  (ClientHandler.handle): Decode "key_id" bytes to string before
  logging it in the debug log.
  (main.debug_gnutls): Decode GnuTLS log message from bytes to string
  before logging it in the debug log.

Show diffs side-by-side

added added

removed removed

Lines of Context:
48
48
  
49
49
  <para id="priority">
50
50
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
51
 
    The default is <quote><literal
52
 
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.  See
53
 
    <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle>
 
51
    The default is
 
52
    <!-- &#x200b; is Unicode ZERO WIDTH SPACE; allows line breaks -->
 
53
    <quote><literal>SECURE128&#x200b;:!CTYPE-X.509&#x200b;:+CTYPE-RAWPK&#x200b;:!RSA&#x200b;:!VERS-ALL&#x200b;:+VERS-TLS1.3&#x200b;:%PROFILE_ULTRA</literal></quote>
 
54
    when using raw public keys in TLS, and
 
55
    <quote><literal>SECURE256&#x200b;:!CTYPE-X.509&#x200b;:+CTYPE-OPENPGP&#x200b;:!RSA&#x200b;:+SIGN-DSA-SHA256</literal></quote>
 
56
    when using OpenPGP keys in TLS,.  See <citerefentry><refentrytitle
 
57
    >gnutls_priority_init</refentrytitle>
54
58
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
55
59
    <emphasis>Warning</emphasis>: changing this may make the
56
60
    <acronym>TLS</acronym> handshake fail, making server-client
57
 
    communication impossible.
 
61
    communication impossible.  Changing this option may also make the
 
62
    network traffic decryptable by an attacker.
58
63
  </para>
59
64
  
60
65
  <para id="servicename">
87
92
  </para>
88
93
  
89
94
  <para id="restore">
90
 
    This option controls whether the server will restore any state from
91
 
    last time it ran. Default is to try restore last state.
 
95
    This option controls whether the server will restore its state
 
96
    from the last time it ran.  Default is to restore last state.
92
97
  </para>
93
98
  
94
99
  <para id="statedir">
97
102
    class="directory">/var/lib/mandos</filename></quote>.
98
103
  </para>
99
104
  
 
105
  <para id="socket">
 
106
    If this option is used, the server will not create a new network
 
107
    socket, but will instead use the supplied file descriptor.  By
 
108
    default, the server will create a new network socket.
 
109
  </para>
 
110
  
 
111
  <para id="foreground">
 
112
    This option will make the server run in the foreground and not
 
113
    write a PID file.  The default is to <emphasis>not</emphasis> run
 
114
    in the foreground, except in <option>debug</option> mode, which
 
115
    implies this option.
 
116
  </para>
 
117
  
 
118
  <para id="zeroconf">
 
119
    This option controls whether the server will announce its
 
120
    existence using Zeroconf.  Default is to use Zeroconf.  If
 
121
    Zeroconf is not used, a <option>port</option> number or a
 
122
    <option>socket</option> is required.
 
123
  </para>
 
124
  
100
125
</section>