summaryrefslogtreecommitdiffstats
path: root/schemas/sslca-key.xsd
blob: 496da859f64e52e3134407fa1d491abae35c364c (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
<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`
      ``sslkey.xml``
    </xsd:documentation>
  </xsd:annotation>

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

  <xsd:complexType name="SSLCAKeyGroupType">
    <xsd:annotation>
      <xsd:documentation>
        An **SSLCAKeyGroupType** is a tag used to provide logic.
        Child entries of an SSLCAKeyGroupType tag only apply to
        machines that match the condition specified -- either
        membership in a group, or a matching client name.
        :xml:attribute:`SSLCAKeyGroupType: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="Key" type="KeyType"/>
      <xsd:element name="Group" type="SSLCAKeyGroupType"/>
      <xsd:element name="Client" type="SSLCAKeyGroupType"/>
      <xsd:element name="KeyInfo" type="KeyInfoType"/>
    </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:`SSLCAKeyGroupType: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="KeyTypeEnum">
    <xsd:annotation>
      <xsd:documentation>
        Available generated key types
      </xsd:documentation>
    </xsd:annotation>
    <xsd:restriction base="xsd:token">
      <xsd:enumeration value="rsa"/>
      <xsd:enumeration value="dsa"/>
    </xsd:restriction>
  </xsd:simpleType>

  <xsd:complexType name="KeyType">
    <xsd:attribute type="xsd:string" name="type" default='rsa'>
      <xsd:annotation>
        <xsd:documentation>
          The key type
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute type="xsd:nonNegativeInteger" name="bits" default="2048">
      <xsd:annotation>
        <xsd:documentation>
          The key length
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attributeGroup ref="py:genshiAttrs"/>
  </xsd:complexType>

  <xsd:complexType name="KeyInfoType">
    <xsd:annotation>
      <xsd:documentation>
        Top-level tag for describing an SSLCA generated key.
      </xsd:documentation>
    </xsd:annotation>
    <xsd:choice minOccurs="1" maxOccurs="unbounded">
      <xsd:group ref="py:genshiElements"/>
      <xsd:element name="Key" type="KeyType"/>
      <xsd:element name="Group" type="SSLCAKeyGroupType"/>
      <xsd:element name="Client" type="SSLCAKeyGroupType"/>
      <xsd:element name="KeyInfo" type="KeyInfoType"/>
    </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:complexType>

  <xsd:element name="KeyInfo" type="KeyInfoType"/>
</xsd:schema>