summaryrefslogtreecommitdiffstats
path: root/schemas/privkey.xsd
blob: f6de534c1f7e9c91050d0020cb2828357d7b45ee (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
153
154
155
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xml:lang="en">
  <xsd:annotation>
    <xsd:documentation>
      Schema for :ref:`server-plugins-generators-cfg-sshkeys` ``privkey.xml``
    </xsd:documentation>
  </xsd:annotation>

  <xsd:include schemaLocation="types.xsd"/>

  <xsd:complexType name="PrivateKeyGroupType">
    <xsd:annotation>
      <xsd:documentation>
        An **PrivateKeyGroupType** is a tag used to provide logic.
        Child entries of a PrivateKeyGroupType tag only apply to
        machines that match the condition specified -- either
        membership in a group, or a matching client name.
        :xml:attribute:`PrivateKeyGroupType:negate` can be set to
        negate the sense of the match.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:choice minOccurs="1" maxOccurs="unbounded">
      <xsd:element name="Passphrase" type="PassphraseType"/>
      <xsd:element name="Params" type="PrivateKeyParamsType"/>
      <xsd:element name="Group" type="PrivateKeyGroupType"/>
      <xsd:element name="Client" type="PrivateKeyGroupType"/>
    </xsd:choice>
    <xsd:attribute name='name' type='xsd:string'>
      <xsd:annotation>
        <xsd:documentation>
          The name of the client or group to match on.  Child entries
          will only apply to this client or group (unless
          :xml:attribute:`PrivateKeyGroupType:negate` is set).
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name='negate' type='xsd:boolean'>
      <xsd:annotation>
        <xsd:documentation>
          Negate the sense of the match, so that child entries only
          apply to a client if it is not a member of the given group
          or does not have the given name.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:complexType>

  <xsd:simpleType name="PrivateKeyTypeEnum">
    <xsd:annotation>
      <xsd:documentation>
        Available private key formats
      </xsd:documentation>
    </xsd:annotation>
    <xsd:restriction base="xsd:string">
      <xsd:enumeration value="rsa"/>
      <xsd:enumeration value="dsa"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:complexType name="PassphraseType">
    <xsd:annotation>
      <xsd:documentation>
        Specify the private key passphrase.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:simpleContent>
      <xsd:extension base="xsd:string">
        <xsd:attribute name="encrypted" type="xsd:string">
          <xsd:annotation>
            <xsd:documentation>
              The name of the passphrase to use to encrypt this
              private key on the filesystem (in Bcfg2).
            </xsd:documentation>
          </xsd:annotation>
        </xsd:attribute>
      </xsd:extension>
    </xsd:simpleContent>
  </xsd:complexType>

  <xsd:complexType name="PrivateKeyParamsType">
    <xsd:annotation>
      <xsd:documentation>
        Specify parameters for creating the private key
      </xsd:documentation>
    </xsd:annotation>
    <xsd:attribute name="bits" type="xsd:positiveInteger">
      <xsd:annotation>
        <xsd:documentation>
          Number of bits in the key.  See :manpage:`ssh-keygen(1)` for
          defaults.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="type" type="PrivateKeyTypeEnum" default="rsa">
      <xsd:annotation>
        <xsd:documentation>
          Key type to create.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:complexType>

  <xsd:element name="PrivateKey">
    <xsd:annotation>
      <xsd:documentation>
        Top-level tag for describing a generated SSH key pair.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:complexType>
      <xsd:choice minOccurs="0" maxOccurs="unbounded">
        <xsd:element name="Passphrase" type="PassphraseType"/>
        <xsd:element name="Params" type="PrivateKeyParamsType"/>
        <xsd:element name="Group" type="PrivateKeyGroupType"/>
        <xsd:element name="Client" type="PrivateKeyGroupType"/>
      </xsd:choice>
      <xsd:attribute name="perhost" type="xsd:boolean">
        <xsd:annotation>
          <xsd:documentation>
            Create keys on a per-host basis (rather than on a per-group
            basis).
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
      <xsd:attribute name="category" type="xsd:string">
        <xsd:annotation>
          <xsd:documentation>
            Create keys specific to the given category, instead of
            specific to the category given in ``bcfg2.conf``.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
      <xsd:attribute name="priority" type="xsd:positiveInteger" default="50">
        <xsd:annotation>
          <xsd:documentation>
            Create group-specific keys with the given priority.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
      <xsd:attribute name="priority" type="xsd:positiveInteger" default="50">
        <xsd:annotation>
          <xsd:documentation>
            Create group-specific keys with the given priority.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
      <xsd:attribute name="decrypt" type="EncryptStrictnessEnum">
        <xsd:annotation>
          <xsd:documentation>
            Override the global strict/lax decryption setting in
            ``bcfg2.conf``.
          </xsd:documentation>
        </xsd:annotation>
      </xsd:attribute>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>