summaryrefslogtreecommitdiff
path: root/docs/template.rst
blob: e2ebe5f0899cff0d9235c71c1ce40e9d097e5719 (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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
==================
Systems - TEMPLATE
==================

Purpose
=======

.. <SHORT DESCRIPTION>

Basics
======

Physical Location
-----------------

.. <PHYSICAL HOST, VM GUEST, APACHE VIRTUAL HOST, etc.>

.. ## Use the following for containers on Infra02:

This system is located in an LXC_ container on physical machine :doc:`infra02`.

Physical Configuration
----------------------

.. seealso::

   See https://wiki.cacert.org/SystemAdministration/EquipmentList

Logical location
----------------

 * IP Internet: <IP>
 * IP Intranet: <IP>
 * IP Internal: <IP>
 * MAC address: <MAC> (interfacename)

.. seealso::

   See :doc:`network`

DNS
---

 * <HOSTNAME>.cacert.org. IN A <IP>
 * <HOSTNAME>.intra.cacert.org. IN A <IP>

.. seealso::

   See https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges

Operating System
----------------

 * Debian GNU/Linux x.y

Applicable Documentation
------------------------

This is it :-)

Administration
==============

System Administration
---------------------

* Primary: <SYSADMIN's NAME>
* Secondary: <secondary name>

Contact
-------

 * <system>-admin@cacert.org

Services
========

Listening services
------------------

+----------+-----------+-----------+-----------------------------------------+
| Port     | Service   | Origin    | Purpose                                 |
+==========+===========+===========+=========================================+
| 22/tcp   | ssh       | ANY       | admin console access                    |
+----------+-----------+-----------+-----------------------------------------+
| 25/tcp   | smtp      | local     | mail delivery to local MTA              |
+----------+-----------+-----------+-----------------------------------------+
| 80/tcp   | http      | ANY       | application                             |
+----------+-----------+-----------+-----------------------------------------+
| 443/tcp  | https     | ANY       | application                             |
+----------+-----------+-----------+-----------------------------------------+
| 5666/tcp | nrpe      | monitor   | remote monitoring service               |
+----------+-----------+-----------+-----------------------------------------+

.. below are some definitions of commonly open ports, choose those that are applicable and order the table by port number
   || 3306/tcp || mysql || local || MySQL database for ... ||
   || 5432/tcp || pgsql || local || PostgreSQL database for ... ||
   || 465/udp || syslog || local || syslog port ||

Running services
----------------

+--------------------+--------------------+----------------------------------------+
| Service            | Usage              | Start mechanism                        |
+====================+====================+========================================+
| openssh server     | ssh daemon for     | init script :file:`/etc/init.d/ssh`    |
|                    | remote             |                                        |
|                    | administration     |                                        |
+--------------------+--------------------+----------------------------------------+
| Apache httpd       | Webserver for ...  | init script                            |
|                    |                    | :file:`/etc/init.d/apache2`            |
+--------------------+--------------------+----------------------------------------+
| cron               | job scheduler      | init script :file:`/etc/init.d/cron`   |
+--------------------+--------------------+----------------------------------------+
| rsyslog            | syslog daemon      | init script                            |
|                    |                    | :file:`/etc/init.d/syslog`             |
+--------------------+--------------------+----------------------------------------+
| PostgreSQL         | PostgreSQL         | init script                            |
|                    | database server    | :file:`/etc/init.d/postgresql`         |
|                    | for ...            |                                        |
+--------------------+--------------------+----------------------------------------+
| MySQL              | MySQL database     | init script                            |
|                    | server for ...     | :file:`/etc/init.d/mysql`              |
+--------------------+--------------------+----------------------------------------+
| Postfix            | SMTP server for    | init script                            |
|                    | local mail         | :file:`/etc/init.d/postfix`            |
|                    | submission, ...    |                                        |
+--------------------+--------------------+----------------------------------------+
| Exim               | SMTP server for    | init script                            |
|                    | local mail         | :file:`/etc/init.d/exim4`              |
|                    | submission, ...    |                                        |
+--------------------+--------------------+----------------------------------------+
| Nagios NRPE server | remote monitoring  | init script                            |
|                    | service queried by | :file:`/etc/init.d/nagios-nrpe-server` |
|                    | :doc:`monitor`     |                                        |
+--------------------+--------------------+----------------------------------------+

Databases
---------

+-------------+--------------+---------------------------+
| RDBMS       | Name         | Used for                  |
+=============+==============+===========================+
| MySQL       | application1 | fictional application one |
+-------------+--------------+---------------------------+
| PostgreSQL  | application2 | fictional application two |
+-------------+--------------+---------------------------+

Running Guests
--------------

+----------------+-------------+---------------+---------+---------------+
| Machine        | IP Intranet | IP Internet   | Ports   | Purpose       |
+================+=============+===============+=========+===============+
| :doc:`machine` | <LOCAL IP>  | <INTERNET IP> | <PORTS> | <DESCRIPTION> |
+----------------+-------------+---------------+---------+---------------+

Connected Systems
-----------------

* :doc:`monitor`

Outbound network connections
----------------------------

* DNS (53) resolving nameservers 172.16.2.2 and 172.16.2.3
* :doc:`emailout` as SMTP relay
* ftp.nl.debian.org as Debian mirror
* security.debian.org for Debian security updates
* crl.cacert.org (rsync) for getting CRLs

Security
========

SSH host keys
-------------

+-----------+-----------------------------------------------------+
| Algorithm | Fingerprint                                         |
+===========+=====================================================+
| RSA       |                                                     |
+-----------+-----------------------------------------------------+
| DSA       |                                                     |
+-----------+-----------------------------------------------------+
| ECDSA     |                                                     |
+-----------+-----------------------------------------------------+
| ED25519   |                                                     |
+-----------+-----------------------------------------------------+

.. seealso::

   See :doc:`sshkeys`

Dedicated user roles
--------------------

.. If the system has some dedicated user groups besides the sudo group used for administration it should be documented here
   Regular operating system groups should not be documented

.. || '''Group''' || '''Purpose''' ||
   || goodguys || Shell access for the good guys ||

Non-distribution packages and modifications
-------------------------------------------

.. * None
   or
   * List of non-distribution packages and modifications

Risk assessments on critical packages
-------------------------------------

Tasks
=====

Critical Configuration items
============================

Keys and X.509 certificates
---------------------------

* :file:`/etc/apache2/ssl/<path to certificate>` server certificate (valid until <datetime>)
* :file:`/etc/apache2/ssl/<path to server key>` server key

.. * `/etc/apache2/ssl/cacert-certs.pem` CAcert.org Class 1 and Class 3 CA certificates (allowed CA certificates for client certificates)
   * `/etc/apache2/ssl/cacert-chain.pem` CAcert.org Class 1 certificate (certificate chain for server certificate)

.. seealso::

   See :doc:`certlist`

Changes
=======

Planned
-------

System Future
.............

.. * No plans

Document Stuff
..............

.. add a paragraph for each larger planned task that seems to be worth
   mentioning. You may want to link to specific issues if you use some issue
   tracker.

Potential Similiar Configurations
.................................

* https://wiki.cacert.org/Exim4Configuration
* https://wiki.cacert.org/PostfixConfiguration
* https://wiki.cacert.org/QmailConfiguration
* https://wiki.cacert.org/SendmailConfiguration
* https://wiki.cacert.org/StunnelConfiguration

Potential System Procedures
...........................

* https://wiki.cacert.org/SystemAdministration/Procedures/DNSChanges
* https://wiki.cacert.org/SystemAdministration/CertificateList

References
==========

.. can be used to provide links to reference documentation
   * http://product.site.com/docs/
   * [[http://product.site.com/whitepaper/document.pdf|Paper on how to setup...]]

Links
=====

.. || [[https://<system>.cacert.org/]] || <System> URL ||
   may contain more URLs if there are multiple useful entry points