summaryrefslogtreecommitdiffstats
path: root/schemas/sslca-cert.xsd
blob: 7330ca0ff13fe962adab65774bbda9f0c613a3f3 (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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:py="http://genshi.edgewall.org/" xml:lang="en">
  <xsd:annotation>
    <xsd:documentation>
      Schema for :ref:`server-plugins-generators-cfg-ssl-certificates`
      ``sslcert.xml``
    </xsd:documentation>
  </xsd:annotation>

  <xsd:import namespace="http://genshi.edgewall.org/"
              schemaLocation="genshi.xsd"/>

  <xsd:complexType name="SSLCACertGroupType">
    <xsd:annotation>
      <xsd:documentation>
        An **SSLCACertGroupType** is a tag used to provide logic.
        Child entries of an SSLCACertGroupType tag only apply to
        machines that match the condition specified -- either
        membership in a group, or a matching client name.
        :xml:attribute:`SSLCACertGroupType:negate` can be set to negate
        the sense of the match.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:choice minOccurs="1" maxOccurs="unbounded">
      <xsd:group ref="py:genshiElements"/>
      <xsd:element name="Cert" type="CertType"/>
      <xsd:element name="Group" type="SSLCACertGroupType"/>
      <xsd:element name="Client" type="SSLCACertGroupType"/>
      <xsd:element name="subjectAltName" type="SubjectAltNameType"/>
      <xsd:element name="CertInfo" type="CertInfoType"/>
    </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:`SSLCACertGroupType: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:attributeGroup ref="py:genshiAttrs"/>
  </xsd:complexType>

  <xsd:simpleType name="SSLCACertFormatEnum">
    <xsd:annotation>
      <xsd:documentation>
        Available certificate formats
      </xsd:documentation>
    </xsd:annotation>
    <xsd:restriction base="xsd:string">
      <xsd:enumeration value="pem"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:simpleType name="SubjectAltNameType">
    <xsd:annotation>
      <xsd:documentation>
        Explicitly specify subject alternative names for the generated
        certificate.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:restriction base="xsd:string"/>
  </xsd:simpleType>

  <xsd:complexType name="CertType">
    <xsd:attribute type="xsd:string" name="key" use="required">
      <xsd:annotation>
        <xsd:documentation>
          The full path to the key entry to use for this certificate.
          This is the *client* path; e.g., for a key defined at
          ``/var/lib/bcfg2/SSLCA/etc/pki/tls/private/foo.key/sslkey.xml``,
          **key** should be ``/etc/pki/tls/private/foo.key``.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="SSLCACertFormatEnum" name="format" default="pem">
      <xsd:annotation>
        <xsd:documentation>
          The certificate format to produce.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:string" name="ca" default="default">
      <xsd:annotation>
        <xsd:documentation>
          The name of the CA (from :ref:`bcfg2.conf
          &lt;server-plugins-generators-cfg-configuration&gt;`) to use
          to generate this certificate.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:integer" name="days" default="365">
      <xsd:annotation>
        <xsd:documentation>
          Time (in days) the certificate will be valid for.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:string" name="c">
      <xsd:annotation>
        <xsd:documentation>
          Override the country set in the CA config
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:string" name="l">
      <xsd:annotation>
        <xsd:documentation>
          Override the location set in the CA config
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:string" name="st">
      <xsd:annotation>
        <xsd:documentation>
          Override the state set in the CA config
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:string" name="ou">
      <xsd:annotation>
        <xsd:documentation>
          Override the organizational unit set in the CA config
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:string" name="o">
      <xsd:annotation>
        <xsd:documentation>
          Override the organization set in the CA config
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:string" name="emailaddress">
      <xsd:annotation>
        <xsd:documentation>
          Override the email address set in the CA config
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:boolean" name="append_chain" default="false">
      <xsd:annotation>
        <xsd:documentation>
          Append the CA chain certificate to the generated certificate
          (e.g., to produce a certificate in the format required by Nginx.)
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attributeGroup ref="py:genshiAttrs"/>
  </xsd:complexType>

  <xsd:complexType name="CertInfoType">
    <xsd:annotation>
      <xsd:documentation>
        Top-level tag for describing an SSLCA generated certificate.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:choice minOccurs="1" maxOccurs="unbounded">
      <xsd:group ref="py:genshiElements"/>
      <xsd:element name="Cert" type="CertType"/>
      <xsd:element name="Group" type="SSLCACertGroupType"/>
      <xsd:element name="Client" type="SSLCACertGroupType"/>
      <xsd:element name="subjectAltName" type="SubjectAltNameType"/>
      <xsd:element name="CertInfo" type="CertInfoType"/>
    </xsd:choice>
    <xsd:attribute name="lax_decryption" type="xsd:boolean">
      <xsd:annotation>
        <xsd:documentation>
          Override the global lax_decryption setting in
          ``bcfg2.conf``.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
  </xsd:complexType>

  <xsd:element name="CertInfo" type="CertInfoType"/>
</xsd:schema>