4 <meta charset="utf-8"/>
5 <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
6 <link rel="stylesheet" href="mandoc.css" type="text/css" media="all"/>
7 <title>GOTD-SECRETS.CONF(5)</title>
9 <!-- This is an automatically generated file. Do not edit.
10 Copyright (c) 2024 Omar Polo <op@openbsd.org>
12 Permission to use, copy, modify, and distribute this software for any
13 purpose with or without fee is hereby granted, provided that the above
14 copyright notice and this permission notice appear in all copies.
16 THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
17 WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
18 MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
19 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
20 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
21 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
22 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
25 <div class="head" role="doc-pageheader" aria-label="Manual header
26 line"><span class="head-ltitle">GOTD-SECRETS.CONF(5)</span>
27 <span class="head-vol">File Formats Manual</span>
28 <span class="head-rtitle">GOTD-SECRETS.CONF(5)</span></div>
29 <main class="manual-text">
31 <h2 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h2>
32 <p class="Pp"><code class="Nm">gotd-secrets.conf</code> —
33 <span class="Nd" role="doc-subtitle">gotd secrets file</span></p>
36 <h2 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h2>
37 <p class="Pp"><code class="Nm">gotd-secrets.conf</code> contains authentication
38 credentials for use with <a class="Xr" aria-label="gotd, section
39 8">gotd(8)</a> notifications. This file must be owned by the root user and
40 must not be readable by any other users.</p>
41 <p class="Pp">The file format is line-based, with one entry per line. Comments
42 can appear at the start of a line using a hash mark (‘#’), and
43 extend to the end of the line. Empty lines are ignored.</p>
44 <p class="Pp">Each entry consists of whitespace-separated tokens and defines a
45 set of credentials. Any credential parameters containing whitespace should
46 be surrounded by single or double quotes.</p>
47 <p class="Pp">Each set of credentials must be given a
48 <var class="Ar">label</var> which can be used to refer to credentials in
49 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>. This
50 <var class="Ar">label</var> must be unique among all credentials of the same
52 <p class="Pp">The supported credential types and their parameters are:</p>
54 <dt id="auth"><a class="permalink" href="#auth"><code class="Ic">auth</code></a>
55 <var class="Ar">label</var> <code class="Ic">user</code>
56 <var class="Ar">user</var> <code class="Ic">password</code>
57 <var class="Ar">password</var></dt>
58 <dd>The <code class="Ic">auth</code> type represents HTTP Basic Authentication
59 credentials consisting of a <var class="Ar">user</var> and a
60 <var class="Ar">password</var>.</dd>
61 <dt id="hmac"><a class="permalink" href="#hmac"><code class="Ic">hmac</code></a>
62 <var class="Ar">label</var> <var class="Ar">secret</var></dt>
63 <dd>The <code class="Ic">hmac</code> type represents shared secrets for use
64 with HMAC signatures of HTTP request bodies. A suitable
65 <var class="Ar">secret</var> can be generated with
66 <a class="Xr" aria-label="openssl, section 1">openssl(1)</a> as follows:
68 <div class="Bd Bd-indent"><code class="Li">$ openssl rand -base64
74 <h2 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h2>
75 <dl class="Bl-tag Bl-compact">
76 <dt><span class="Pa">/etc/gotd-secrets.conf</span></dt>
77 <dd>Location of the <code class="Nm">gotd-secrets.conf</code> configuration
82 <h2 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h2>
83 <p class="Pp">Define credentials for HTTP basic authentication and HMAC
85 <div class="Bd Pp Bd-indent Li">
86 <pre># /etc/gotd-secrets.conf
87 auth mochi user "flan" password "super-strong-password!"
88 hmac hacker q0tcl8QhjYs7U75MW/2rwB30CpdbAhONkfLGxFHm/+8=</pre>
90 <p class="Pp">These credentials can be referenced in
91 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a> as
93 <div class="Bd Pp Bd-indent Li">
95 repository "openbsd/src" {
96 path "/var/git/src.git"
100 url https://example.com/ci/ auth mochi hmac hacker
106 <h2 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
108 <p class="Pp"><a class="Xr" aria-label="got, section 1">got(1)</a>,
109 <a class="Xr" aria-label="gotsh, section 1">gotsh(1)</a>,
110 <a class="Xr" aria-label="gotd.conf, section 5">gotd.conf(5)</a>,
111 <a class="Xr" aria-label="gotd, section 8">gotd(8)</a></p>
114 <div class="foot" role="doc-pagefooter" aria-label="Manual footer
115 line"><span class="foot-left"></span><span class="foot-date">November 21,
116 2024</span> <span class="foot-os">OpenBSD 7.6</span></div>
