summaryrefslogtreecommitdiff
path: root/man/ostree-sign.xml
blob: 50c0b337b9718160c1cb9e8fcccd3edb5cb28391 (plain)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
Copyright 2019 Denis Pynkin <denis.pynkin@collabora.com>

SPDX-License-Identifier: LGPL-2.0+

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
-->

<refentry id="ostree">

    <refentryinfo>
        <title>ostree sign</title>
        <productname>OSTree</productname>

        <authorgroup>
            <author>
                <contrib>Developer</contrib>
                <firstname>Colin</firstname>
                <surname>Walters</surname>
                <email>walters@verbum.org</email>
            </author>
        </authorgroup>
    </refentryinfo>

    <refmeta>
        <refentrytitle>ostree sign</refentrytitle>
        <manvolnum>1</manvolnum>
    </refmeta>

    <refnamediv>
        <refname>ostree-sign</refname>
        <refpurpose>Sign a commit</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
        <cmdsynopsis>
            <command>ostree sign</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMIT</arg> <arg choice="req" rep="repeat">KEY-ID</arg>
        </cmdsynopsis>
    </refsynopsisdiv>

    <refsect1>
        <title>Description</title>

        <para>
            Add a new signature to a commit.

            Note that currently, this will append a new signature even if
            the commit is already signed with a given key.
        </para>

        <para>
            There are several "well-known" system places for `ed25519` trusted and revoked public keys -- expected single <literal>base64</literal>-encoded key per line.
        </para>

        <para>Files:
            <itemizedlist>
                <listitem><para><filename>/etc/ostree/trusted.ed25519</filename></para></listitem>
                <listitem><para><filename>/etc/ostree/revoked.ed25519</filename></para></listitem>
                <listitem><para><filename>/usr/share/ostree/trusted.ed25519</filename></para></listitem>
                <listitem><para><filename>/usr/share/ostree/revoked.ed25519</filename></para></listitem>
            </itemizedlist>
        </para>

        <para>Directories containing files with keys:
            <itemizedlist>
                <listitem><para><filename>/etc/ostree/trusted.ed25519.d</filename></para></listitem>
                <listitem><para><filename>/etc/ostree/revoked.ed25519.d</filename></para></listitem>
                <listitem><para><filename>/usr/share/ostree/trusted.ed25519.d</filename></para></listitem>
                <listitem><para><filename>/usr/share/ostree/rvokeded.ed25519.d</filename></para></listitem>
            </itemizedlist>
        </para>
    </refsect1>

    <refsect1>
        <title>Options</title>

        <variablelist>
            <varlistentry>
                <term><option>KEY-ID</option></term>
                <listitem><para>
                        <variablelist>
                            <varlistentry>
                                <term><option>for ed25519:</option></term>
                                <listitem><para>
                                        <literal>base64</literal>-encoded secret (for signing) or public key (for verifying).
                                </para></listitem>
                            </varlistentry>

                            <varlistentry>
                                <term><option>for dummy:</option></term>
                                <listitem><para>
                                            ASCII-string used as secret key and public key.
                                </para></listitem>
                            </varlistentry>
                        </variablelist>
                </para></listitem>
            </varlistentry>
            <varlistentry>
                <term><option>--verify</option></term>
                <listitem><para>
                    Verify signatures
                </para></listitem>
            </varlistentry>
            <varlistentry>
                <term><option>-s, --sign-type</option></term>
                <listitem><para>
                    Use particular signature mechanism. Currently
                    available <arg choice="plain">ed25519</arg> and <arg choice="plain">dummy</arg>
                    signature types.

                    The default is <arg choice="plain">ed25519</arg>.
                </para></listitem>
            </varlistentry>
           <varlistentry>
                <term><option>--keys-file</option></term>
                <listitem><para>
                    Read key(s) from file <filename>filename</filename>.
                </para></listitem>

                <listitem><para>
                    Valid for <literal>ed25519</literal> signature type.
                    For <literal>ed25519</literal> this file must contain <literal>base64</literal>-encoded
                    secret key(s) (for signing) or public key(s) (for verifying) per line.
                </para></listitem>
            </varlistentry>
            <varlistentry>
                <term><option>--keys-dir</option></term>
                <listitem><para>
                    Redefine the system path, where to search files and subdirectories with
                    well-known and revoked keys.
                </para></listitem>
            </varlistentry>
        </variablelist>
    </refsect1>
</refentry>