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