openarc(8)

1openarc(8)                  System Manager's Manual                 openarc(8)
2
3
4

NAME

6       openarc - ARC signing and verifying filter for MTAs
7

SYNOPSIS

9       openarc  [-c  configfile]  [-f]  [-n]  [-p socketspec] [-P pidfile] [-u
10       userid[:group]] [-v] [-V]
11

DESCRIPTION

13       openarc implements the  proposed  ARC  (Authenticated  Received  Chain)
14       standard  for confirming handling and authentication of a message as it
15       is handled for delivery.
16
17       openarc uses the milter interface, originally distributed  as  part  of
18       version  8.11  of  sendmail(8), to provide ARC signing and/or verifying
19       service for mail transiting a milter-aware MTA.
20

OPTIONS

22       -c configfile
23              Read the named configuration file.  See the openarc.conf(5)  man
24              page for details.  Values in the configuration file are overrid‐
25              den when their equivalents are  provided  on  the  command  line
26              until  a  configuration reload occurs.  The default is to read a
27              configuration file from /etc/openarc.conf if one exists, or oth‐
28              erwise to apply defaults to all values.
29
30       -f     Normally  openarc  forks and exits immediately, leaving the ser‐
31              vice running in the background.  This flag suppresses  that  be‐
32              haviour so that it runs in the foreground.
33
34       -n     Parse the configuration file and command line arguments, report‐
35              ing any errors found, and then exit.  The exit value will  be  0
36              if the filter would start up without complaint, or non-zero oth‐
37              erwise.
38
39       -p socketspec
40              Specifies the socket that should be established by the filter to
41              receive  connections  from  sendmail(8) in order to provide ser‐
42              vice.  socketspec is in one of two forms: local:path which  cre‐
43              ates   a   UNIX   domain   socket  at  the  specified  path,  or
44              inet:port[@host] or inet6:port[@host] which creates a TCP socket
45              on  the  specified port using the requested protocol family.  If
46              the host is not given as either a hostname or an IP address, the
47              socket  will  be  listening  on  all  interfaces.   A literal IP
48              address must be enclosed in square brackets.  If neither  socket
49              type  is  specified,  local is assumed, meaning the parameter is
50              interpreted as a path at which the  socket  should  be  created.
51              This  parameter is mandatory either here or in the configuration
52              file.
53
54       -P pidfile
55              Specifies a file into which the filter should write its  process
56              ID at startup.
57
58       -u userid[:group]
59              Attempts  to be come the specified userid before starting opera‐
60              tions.  The process will be assigned all of the groups and  pri‐
61              mary  group  ID of the named userid unless an alternate group is
62              specified.  See the FILE PERMISSIONS section for  more  informa‐
63              tion.
64
65       -V     Print  the  version number and build-time options, and then exit
66              without doing anything else.
67

EXIT STATUS

69       Filter exit status codes are selected according to sysexits(3).
70

VERSION

72       This man page covers version 0.1.0 of openarc.
73

COPYRIGHT

75       Copyright (c) 2005-2008, Sendmail, Inc. and its suppliers.  All  rights
76       reserved.
77
78       Copyright  (c)  2009-2013, 2015, 2016, The Trusted Domain Project.  All
79       rights reserved.
80