This repository has been archived by the owner on Feb 13, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 137
/
stdconfig.py
1893 lines (1623 loc) · 75.9 KB
/
stdconfig.py
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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- test-case-name: twistedcaldav.test.test_stdconfig -*-
##
# Copyright (c) 2005-2017 Apple Inc. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
##
from os.path import basename
from plistlib import PlistParser # @UnresolvedImport
from socket import getfqdn, gethostbyname
import copy
import os
import re
import sys
from calendarserver.push.util import getAPNTopicFromConfig
from twext.enterprise.jobs.jobitem import JobItem
from twext.enterprise.jobs.queue import ControllerQueue
from twext.enterprise.jobs.workitem import WorkItem
from twext.python.log import Logger
from twisted.logger import InvalidLogLevelError, LogLevel
from twisted.python.filepath import FilePath
from twisted.python.runtime import platform
from twistedcaldav import ical
from twistedcaldav.config import ConfigProvider, ConfigurationError, ConfigDict
from twistedcaldav.config import config, mergeData, fullServerPath
from twistedcaldav.datafilters.peruserdata import PerUserDataFilter
from twistedcaldav.util import KeychainAccessError, KeychainPasswordNotFound
from twistedcaldav.util import computeProcessCount
from twistedcaldav.util import getPasswordFromKeychain
from txdav.xml import element as davxml
from txweb2.dav.resource import TwistedACLInheritable
log = Logger()
if platform.isMacOSX():
DEFAULT_CONFIG_FILE = "/Applications/Server.app/Contents/ServerRoot/private/etc/caldavd/caldavd-apple.plist"
else:
DEFAULT_CONFIG_FILE = "/etc/caldavd/caldavd.plist"
DEFAULT_SERVICE_PARAMS = {
"xml": {
"recordTypes": ["users", "groups"],
"xmlFile": "accounts.xml",
},
"opendirectory": {
"recordTypes": ["users", "groups"],
"node": "/Search",
},
"ldap": {
"recordTypes": ["users", "groups"],
"uri": "ldap://localhost/",
"useTLS": False,
"credentials": {
"dn": None,
"password": None,
},
"rdnSchema": {
"base": "dc=example,dc=com",
"users": "cn=users",
"groups": "cn=groups",
"locations": "cn=locations",
"resources": "cn=resources",
"addresses": "cn=addresses",
},
"mapping": {
"uid": ["apple-generateduid"],
"guid": ["apple-generateduid"],
"shortNames": ["uid"],
"fullNames": ["cn"],
"emailAddresses": ["mail"],
"memberDNs": ["uniqueMember"],
"readOnlyProxy": ["icsSecondaryOwners"],
"readWriteProxy": ["icsContact"],
"loginAllowed": [],
"hasCalendars": [],
"autoScheduleMode": [],
"autoAcceptGroup": [],
"serviceNodeUID": [],
"associatedAddress": [],
"geographicLocation": [],
"streetAddress": [],
},
"extraFilters": {
"users": "",
"groups": "",
"locations": "",
"resources": "",
"addresses": "",
},
"threadPoolMax": 10,
"authConnectionMax": 5,
"queryConnectionMax": 5,
"tries": 3,
"warningThresholdSeconds": 5,
},
}
DEFAULT_RESOURCE_PARAMS = {
"xml": {
"recordTypes": ["locations", "resources", "addresses"],
"xmlFile": "resources.xml",
},
"opendirectory": {
"recordTypes": ["locations", "resources", "addresses"],
"node": "/Search",
},
}
DEFAULT_AUGMENT_PARAMS = {
"xml": {
"xmlFiles": [],
"statSeconds": 15,
},
}
DEFAULT_DIRECTORY_ADDRESSBOOK_PARAMS = {
"opendirectory": {
"queryPeopleRecords": True,
"peopleNode": "/Search/Contacts",
"queryUserRecords": True,
"userNode": "/Search/Contacts",
"maxDSQueryRecords": 0,
"queryDSLocal": False,
"ignoreSystemRecords": True,
"dsLocalCacheTimeout": 30,
"liveQuery": True,
"fakeETag": True,
"cacheQuery": False,
"cacheTimeout": 30,
"standardizeSyntheticUIDs": False,
"addDSAttrXProperties": False,
"appleInternalServer": False,
"additionalAttributes": [],
"allowedAttributes": [],
},
}
# Note: Don't use None values below; that confuses the command-line parser.
DEFAULT_CONFIG = {
#
# Public network address information
#
# This is the server's public network address, which is provided to
# clients in URLs and the like. It may or may not be the network
# address that the server is listening to directly, though it is by
# default. For example, it may be the address of a load balancer or
# proxy which forwards connections to the server.
#
"ServerHostName": "", # Network host name.
"HTTPPort": 0, # HTTP port (0 to disable HTTP)
"SSLPort": 0, # SSL port (0 to disable HTTPS)
"EnableSSL": False, # Whether to listen on SSL port(s)
"BehindTLSProxy": False, # Whether the service is offloading TLS duty to a proxy
"RedirectHTTPToHTTPS": False, # If True, all nonSSL requests redirected to an SSL Port
"SSLMethod": "SSLv23_METHOD", # SSLv2_METHOD, SSLv3_METHOD, SSLv23_METHOD, TLSv1_METHOD
"SSLCiphers": "RC4-SHA:HIGH:!ADH",
# Max-age value for Strict-Transport-Security header; set to 0 to disable header.
"StrictTransportSecuritySeconds": 7 * 24 * 60 * 60,
#
# Network address configuration information.
#
# This configures the actual network address that the server binds to.
#
"SocketFiles": {
"Enabled": False,
"Secured": "secured.sock", # Socket file to listen for secure requests on
"Unsecured": "unsecured.sock", # Socket file to listen for insecure requests on
"Owner": "",
"Group": "",
"Permissions": 0770,
},
"SocketRoot": "/tmp/calendarserver",
"BindAddresses": [], # List of IP addresses to bind to [empty = all]
"BindHTTPPorts": [], # List of port numbers to bind to for HTTP
# [empty = same as "Port"]
"BindSSLPorts": [], # List of port numbers to bind to for SSL [empty = same as "SSLPort"]
"InheritFDs": [], # File descriptors to inherit for HTTP requests [empty = don't inherit]
"InheritSSLFDs": [], # File descriptors to inherit for HTTPS requests [empty = don't inherit]
"UseMetaFD": True, # Use a 'meta' FD, i.e. an FD to transmit other FDs to slave processes.
"MetaFD": 0, # Inherited file descriptor to call recvmsg() on to receive sockets (none = don't inherit)
#
# Database configuration information.
#
# Defines what kind of database to use: file (deprecated) or SQL.
# File-based DB is only supported for migration purposes - it
# cannot be used for a real service.
#
# For an SQL-based DB, configuration of connection parameters and various
# timeouts is provided.
#
"UseDatabase": True, # True: database; False: files (deprecated)
"DBType": "", # Possible values: empty, meaning 'spawn postgres
# yourself', or 'postgres' or 'oracle', meaning
# 'connect to a postgres or Oracle database as
# specified by the 'DSN' configuration key.
"DBFeatures": [ # Features supported by the database
#
# 'skip-locked': SKIP LOCKED available with SELECT (remove if using postgres < v9.5)
#
"skip-locked",
],
"SpawnedDBUser": "caldav", # The username to use when DBType is empty
"DatabaseConnection": { # Used to connect to an external database if DBType is non-empty
"endpoint": "", # Database connection endpoint
"database": "", # Name of database or Oracle SID
"user": "", # User name to connect as
"password": "", # Password to use
"ssl": False, # Set to True to require SSL (pg8000 only).
},
"SharedConnectionPool": False, # Use a shared database connection pool in
# the master process, rather than having
# each client make its connections directly.
"DBAMPFD": 0, # Internally used by database to tell slave
# processes to inherit a file descriptor and use it
# as an AMP connection over a UNIX socket; see
# twext.enterprise.adbapi2.ConnectionPoolConnection
"FailIfUpgradeNeeded": True, # Set to True to prevent the server or utility
# tools from running if the database needs a schema
# upgrade.
"CheckExistingSchema": False, # Set to True to check the current database schema
# against the schema file matching the database schema
# version.
"UpgradeHomePrefix": "", # When upgrading, only upgrade homes where the owner UID starts with
# the specified prefix. The upgrade will only be partial and only
# apply to upgrade pieces that affect entire homes. The upgrade will
# need to be run again without this prefix set to complete the overall
# upgrade.
"TransactionTimeoutSeconds": 300, # Timeout transactions that take longer than
# the specified number of seconds. Zero means
# no timeouts. 5 minute default.
"TransactionHTTPRetrySeconds": 300, # When a transactions times out tell HTTP clients
# clients to retry after this amount of time
#
# Work queue configuration information
#
"WorkQueue": {
"queuePollInterval": 0.1, # Interval in seconds for job queue polling
"queueOverdueTimeout": 300, # Number of seconds before an assigned job is considered overdue
"queuePollingBackoff": [ # Array of array that describe the threshold and new polling interval
# for job queue polling back off
[60, 60], [5, 1]
],
"overloadLevel": 95, # Queue capacity (percentage) which causes job processing to halt
"highPriorityLevel": 80, # Queue capacity (percentage) at which only high priority items are run
"mediumPriorityLevel": 50, # Queue capacity (percentage) at which only high/medium priority items are run
"rowLimit": 1, # This is used to help with concurrency problems when the underlying DB does
# not support a proper "LIMIT" term with the query (Oracle). It should be set to no more than
# 1 plus the number of app-servers in use. For a single app-server, always use 1.
"failureRescheduleInterval": 60, # When a job fails, reschedule it this number of seconds in the future
"lockRescheduleInterval": 60, # When a job can't run because of a lock, reschedule it this number of seconds in the future
"workParameters": {}, # dict of work table name's, whose values are dicts containing "priority"
# and "weight" items to use for newly created work.
},
#
# Types of service provided
#
"EnableCalDAV": True, # Enable CalDAV service
"EnableCardDAV": True, # Enable CardDAV service
"MigrationOnly": False, # When True override all other services and set the server into podding-only mode
#
# Data store
#
"ServerRoot": "/var/db/caldavd", # The top level directory, contains (by default) ConfigRoot and DataRoot
"DataRoot": "Data", # Data directory, parent to DatabaseRoot, AttachmentsRoot, and others
"DatabaseRoot": "Database", # Database directory, contains PostgreSQL cluster
"AttachmentsRoot": "Attachments", # Attachments directory, where file attachments are stored
"DocumentRoot": "Documents", # Documents directory, contains files to be served as HTTP resources at the root level
"ConfigRoot": "Config", # Config directory, contains additional config files
"LogRoot": "/var/log/caldavd", # Log directory, contains access.log, error.log and others
"RunRoot": "/var/run/caldavd", # Run-time directory, contains PID files and UNIX socket files
"WebCalendarRoot": "/Applications/Server.app/Contents/ServerRoot/usr/share/collabd/webcal/public", # WebCal directory, contains HTML implementing the web calendar
#
# Quotas
#
# Attachments
"UserQuota": 104857600, # User attachment quota (in bytes - default 100MB)
"MaximumAttachmentSize": 10485760, # Maximum size for a single attachment (in bytes - default 10MB)
"MaximumAttachmentsPerInstance": 5, # Maximum number of attachments per instance
# Resource data
"MaxCollectionsPerHome": 50, # Maximum number of calendars/address books allowed in a home
"MaxResourcesPerCollection": 10000, # Maximum number of resources in a calendar/address book
"MaxResourceSize": 1048576, # Maximum resource size (in bytes)
"MaxAttendeesPerInstance": 100, # Maximum number of unique attendees
"MaxAllowedInstances": 3000, # Maximum number of instances the server will index
# Set to URL path of wiki authentication service, e.g. "/auth", in order
# to use javascript authentication dialog. Empty string indicates standard
# browser authentication dialog should be used.
"WebCalendarAuthPath": "",
# Define mappings of URLs to file system objects (directories or files)
"Aliases": [],
#
# Directory service
#
# A directory service provides information about principals (e.g.
# users, groups, locations and resources) to the server.
#
"DirectoryService": {
"Enabled": True,
"type": "xml",
"params": DEFAULT_SERVICE_PARAMS["xml"],
},
"DirectoryRealmName": "",
# Apply an additional filter for attendee lookups where names must start
# with the search tokens rather than just contain them.
"DirectoryFilterStartsWith": False,
#
# Locations and Resources service
#
# Supplements the directory service with information about locations
# and resources.
#
"ResourceService": {
"Enabled": True,
"type": "xml",
"params": DEFAULT_RESOURCE_PARAMS["xml"],
},
#
# Augment service
#
# Augments for the directory service records to add calendar specific attributes.
#
"AugmentService": {
"type": "xml",
"params": DEFAULT_AUGMENT_PARAMS["xml"],
},
#
# Proxies
#
"ProxyLoadFromFile": "", # Allows for initialization of the proxy database from an XML file
#
# Special principals
#
"AdminPrincipals": [], # Principals with "DAV:all" access (relative URLs)
"ReadPrincipals": [], # Principals with "DAV:read" access (relative URLs)
"EnableProxyPrincipals": True, # Create "proxy access" principals
#
# Permissions
#
"EnableAnonymousReadRoot": True, # Allow unauthenticated read access to /
"EnableAnonymousReadNav": False, # Allow unauthenticated read access to hierarchy
"EnablePrincipalListings": True, # Allow listing of principal collections
"EnableMonolithicCalendars": True, # Render calendar collections as a monolithic iCalendar object
#
# Client controls
#
"RejectClients": [], # List of regexes for clients to disallow
#
# Authentication
#
"Authentication": {
"Basic": { # Clear text; best avoided
"Enabled": True,
"AllowedOverWireUnencrypted": False, # Advertised over non-SSL?
},
"Digest": { # Digest challenge/response
"Enabled": True,
"Algorithm": "md5",
"Qop": "",
"AllowedOverWireUnencrypted": True, # Advertised over non-SSL?
},
"Kerberos": { # Kerberos/SPNEGO
"Enabled": False,
"ServicePrincipal": "",
"AllowedOverWireUnencrypted": True, # Advertised over non-SSL?
},
"ClientCertificate": { # TLS Client Certificate
"Enabled": False,
"AllowedOverWireUnencrypted": True, # Advertised over non-SSL?
"Required": True, # Always require a client cert
"CAFiles": [], # Array of acceptable client cert CA file names
"SendCAsToClient": True, # Send the list of acceptable CAs to the client
},
"Wiki": {
"Enabled": False,
"Cookie": "cc.collabd_session_guid",
"EndpointDescriptor": "unix:path=/var/run/collabd"
},
},
#
# Logging
#
"AccessLogFile": "access.log", # Apache-style access log
"ErrorLogFile": "error.log", # Server activity log (the verbosity is controlled by DefaultLogLevel and LogLevels keys)
"AgentLogFile": "agent.log", # Agent activity log (only applies to Server.app edition)
"UtilityLogFile": "utility.log", # Utility log (used for command line utilities; the name will be dynamically changed to that of the utility being run)
"ErrorLogEnabled": True, # True = use log file, False = stdout
"ErrorLogRotateMB": 10, # Rotate error log after so many megabytes
"ErrorLogMaxRotatedFiles": 5, # Retain this many error log files
"ErrorLogRotateOnStart": False, # Rotate error log when service starts
"PIDFile": "caldavd.pid",
"RotateAccessLog": False,
"EnableExtendedAccessLog": True,
"EnableExtendedTimingAccessLog": False,
"DefaultLogLevel": "", # Controls the verbosity of ErrorLogFile (valid values are error, warn, info, debug; default is info)
"LogLevels": {}, # Allows overriding log levels on a per-package, per-module, or even per-class basis
"LogID": "", # Used internally to track which worker process is logging a message
"AccountingCategories": {
"HTTP": False, # Log regular HTTP requests
"iTIP": False, # Log non-freebusy iTIP details
"iTIP-VFREEBUSY": False, # Log freebusy iTIP details
"Implicit Errors": False, # Log extra details about implicit scheduling errors
"AutoScheduling": False, # Log extra details about auto-accept iTIP processing
"iSchedule": False, # Log iSchedule HTTP requests (including cross-pod)
"xPod": False, # Log cross-pod conduit HTTP requests
"Invalid Instance": False, # Log invalid recurrence instance details
"migration": False, # Log cross-pod migration details
},
"AccountingPrincipals": [],
"AccountingLogRoot": "accounting", # The parent directory for accounting log directories (by default, relative to LogRoot)
"Stats": {
"EnableUnixStatsSocket": False,
"UnixStatsSocket": "caldavd-stats.sock",
"EnableTCPStatsSocket": False,
"TCPStatsPort": 8100,
},
"LogDatabase": {
"LabelsInSQL": False,
"Statistics": False,
"StatisticsLogFile": "sqlstats.log",
"SQLStatements": False,
"TransactionWaitSeconds": 0,
},
#
# SSL/TLS
#
"SSLCertificate": "", # Public key
"SSLPrivateKey": "", # Private key
"SSLAuthorityChain": "", # Certificate Authority Chain
"SSLPassPhraseDialog": "/etc/apache2/getsslpassphrase",
"SSLCertAdmin": "/Applications/Server.app/Contents/ServerRoot/usr/sbin/certadmin",
"SSLKeychainIdentity": "", # Keychain identity to use in place of cert files
#
# Process management
#
# Username and Groupname to drop privileges to, if empty privileges will not be dropped.
"UserName": "",
"GroupName": "",
# Multi-process
"ProcessType": "Combined",
"MultiProcess": {
"ProcessCount": 0,
"MinProcessCount": 2,
"PerCPU": 1,
"PerGB": 1,
"StaggeredStartup": {
"Enabled": False,
"Interval": 15,
},
},
# How large a spawned process is allowed to get before it's stopped
"MemoryLimiter": {
"Enabled": True,
"Seconds": 60, # How often to check memory sizes (in seconds)
"Bytes": 2 * 1024 * 1024 * 1024, # Memory limit (RSS in bytes)
"ResidentOnly": True, # True: only take into account resident memory; False: include virtual memory
},
"EnableSACLs": False, # If enabled, will honor macOS Server ACLs to control access
"EnableReadOnlyServer": False, # Make all data read-only
#
# Standard (or draft) WebDAV extensions
#
"EnableAddMember": True, # POST ;add-member extension
"EnableSyncReport": True, # REPORT collection-sync
"EnableSyncReportHome": True, # REPORT collection-sync on home collections
"EnableConfigSyncToken": True, # Sync token includes config component
"EnableWellKnown": True, # /.well-known resource
"EnableCalendarQueryExtended": True, # Extended calendar-query REPORT
"EnableManagedAttachments": False, # Support Managed Attachments
"EnableServerInfo": False, # server-info document
#
# Generic CalDAV/CardDAV extensions
#
"EnableJSONData": True, # Allow clients to send/receive JSON jCal and jCard format data
#
# Non-standard CalDAV extensions
#
"EnableDropBox": False, # Calendar Drop Box
"EnablePrivateEvents": False, # Private Events
"EnableTimezoneService": False, # Old Timezone service
"TimezoneService": { # New standard timezone service
"Enabled": True, # Overall on/off switch
"URI": "/stdtimezones", # URI where service is hosted
"Mode": "primary", # Can be "primary" or "secondary"
"BasePath": "", # Path to directory containing a zoneinfo - if None use default package path
# secondary service MUST define its own writable path
"XMLInfoPath": "", # Path to db cache info - if None use default package path
# secondary service MUST define its own writable path if
# not None
"PrettyPrintJSON": True, # User friendly JSON output
"SecondaryService": {
# Only one of these should be used when a secondary service is used
"Host": "", # Domain/IP of secondary service to discover
"URI": "", # HTTP(s) URI to secondary service
"UpdateIntervalMinutes": 24 * 60,
}
},
"EnableTimezonesByReference": True, # Strip out VTIMEZONES that are known
"UsePackageTimezones": False, # Use timezone data from twistedcaldav.zoneinfo - don't copy to Data directory
"EnableBatchUpload": True, # POST batch uploads
"MaxResourcesBatchUpload": 100, # Maximum number of resources in a batch POST
"MaxBytesBatchUpload": 10485760, # Maximum size of a batch POST (10 MB)
"Sharing": {
"Enabled": True, # Overall on/off switch
"AllowExternalUsers": False, # External (non-principal) sharees allowed
"Calendars": {
"Enabled": True, # Calendar on/off switch
"IgnorePerUserProperties": [
"X-APPLE-STRUCTURED-LOCATION",
],
"CollectionProperties": {
"Shadowable": [
"{urn:ietf:params:xml:ns:caldav}calendar-description",
],
"ProxyOverride": [
"{urn:ietf:params:xml:ns:caldav}calendar-description",
"{com.apple.ical:}calendarcolor",
"{http://apple.com/ns/ical/}calendar-color",
"{http://apple.com/ns/ical/}calendar-order",
],
"Global": [
],
},
"Groups": {
"Enabled": True, # Calendar sharing to groups on/off switch
"ReconciliationDelaySeconds": 5,
},
},
"AddressBooks": {
"Enabled": False, # Address Book sharing on/off switch
"CollectionProperties": {
"Shadowable": [
"{urn:ietf:params:xml:ns:carddav}addressbook-description",
],
"ProxyOverride": [
],
"Global": [
],
},
"Groups": {
"Enabled": False, # Address Book Group sharing on/off switch
},
},
},
"RestrictCalendarsToOneComponentType": True, # Only allow calendars to be created with a single component type
# If this is on, it will also trigger an upgrade behavior that will
# split existing calendars into multiples based on component type.
# If on, it will also cause new accounts to provision with separate
# calendars for events and tasks.
"SupportedComponents": [ # Set of supported iCalendar components
"VEVENT",
"VTODO",
],
"EnableTrashCollection": False, # Enable Trash Collection
"ExposeTrashCollection": False, # Expose Trash Collection as a resource
"ParallelUpgrades": False, # Perform upgrades - currently only the
# database to filesystem migration - but in
# the future, hopefully all relevant
# upgrades - in parallel in subprocesses.
"MergeUpgrades": False, # During the upgrade phase of startup, rather than
# skipping homes found both on the filesystem and in
# the database, merge the data from the filesystem
# into the database homes.
"EnableDefaultAlarms": True, # Support for default alarms generated by the server
"RemoveDuplicateAlarms": True, # Remove duplicate alarms on PUT
"RemoveDuplicatePrivateComments": False, # Remove duplicate private comments on PUT
"HostedStatus": {
"Enabled": False, # Decorate ATTENDEEs with the following parameter
# to indicate where the ATTENDEE is hosted, locally
# or externally. It's configurable and extensible in
# case we want to add more values. A value of empty
# string means no decoration.
"Parameter": "X-APPLE-HOSTED-STATUS",
"Values": {
"local": "",
"external": "EXTERNAL",
},
},
"RevisionCleanup": {
"Enabled": True,
"SyncTokenLifetimeDays": 14.0, # Number of days that a client sync report token is valid
"CleanupPeriodDays": 2.0, # Number of days between revision cleanups
},
"InboxCleanup": {
"Enabled": True,
"ItemLifetimeDays": 14.0, # Number of days before deleting a new inbox item
"CleanupPeriodDays": 2.0, # Number of days between inbox cleanups
"StartDelaySeconds": 5 * 60, # Number of seconds before CleanupOneInboxWork starts after InboxCleanupWork
"StaggerSeconds": 0.5, # Number of seconds between each CleanupOneInboxWork (fractional)
"InboxRemoveWorkThreshold": 5, # Number of items above which inbox removals will be deferred to a work item
"RemovalStaggerSeconds": 0.5, # Number of seconds between each InboxRemoveWork
},
# CardDAV Features
"DirectoryAddressBook": {
"Enabled": True,
"type": "opendirectory",
"params": DEFAULT_DIRECTORY_ADDRESSBOOK_PARAMS["opendirectory"],
"name": "directory",
"MaxQueryResults": 1000,
},
"EnableSearchAddressBook": False, # /directory resource exists
"AnonymousDirectoryAddressBookAccess": False, # Anonymous users may access directory address book
# /XXX CardDAV
# Web-based administration
"EnableWebAdmin": True,
# JSON control API - only for testing
"EnableControlAPI": False,
#
# Scheduling related options
#
"Scheduling": {
"CalDAV": {
"EmailDomain": "", # Domain for mailto calendar user addresses on this server
"HTTPDomain": "", # Domain for http calendar user addresses on this server
"AddressPatterns": [], # Regex patterns to match local calendar user addresses
"OldDraftCompatibility": True, # Whether to maintain compatibility with non-implicit mode
"ScheduleTagCompatibility": True, # Whether to support older clients that do not use Schedule-Tag feature
"EnablePrivateComments": True, # Private comments from attendees to organizer
"PerAttendeeProperties": [ # Names of iCalendar properties that are preserved when an Attendee does an invite PUT
"X-APPLE-NEEDS-REPLY",
"X-APPLE-TRAVEL-DURATION",
"X-APPLE-TRAVEL-START",
"X-APPLE-TRAVEL-RETURN-DURATION",
"X-APPLE-TRAVEL-RETURN",
],
"OrganizerPublicProperties": [ # Names of X- iCalendar properties that are sent from ORGANIZER to ATTENDEE
"X-APPLE-DROPBOX",
"X-APPLE-STRUCTURED-LOCATION",
],
"OrganizerPublicParameters": [ # Names of X- iCalendar parameters that are sent from ORGANIZER to ATTENDEE
],
"AttendeePublicProperties": [ # Names of X- iCalendar properties that are sent from ATTENDEE to ORGANIZER
# These are also implicitly added to OrganizerPublicProperties
],
"AttendeePublicParameters": [ # Names of X- iCalendar parameters that are sent from ATTENDEE to ORGANIZER
# These are also implicitly added to OrganizerPublicParameters
],
},
"iSchedule": {
"Enabled": False, # iSchedule protocol
"AddressPatterns": [], # Reg-ex patterns to match iSchedule-able calendar user addresses
"RemoteServers": "remoteservers.xml", # iSchedule server configurations
"SerialNumber": 1, # Capabilities serial number
"DNSDebug": "", # File where a fake Bind zone exists for creating fake DNS results
"DKIM": { # DKIM options
"Enabled": True, # DKIM signing/verification enabled
"Domain": "", # Domain for DKIM (defaults to ServerHostName)
"KeySelector": "ischedule", # Selector for public key
"SignatureAlgorithm": "rsa-sha256", # Signature algorithm (one of rsa-sha1 or rsa-sha256)
"UseDNSKey": True, # This server's public key stored in DNS
"UseHTTPKey": True, # This server's public key stored in HTTP /.well-known
"UsePrivateExchangeKey": True, # This server's public key manually exchanged with others
"ExpireSeconds": 3600, # Expiration time for signature verification
"PrivateKeyFile": "", # File where private key is stored
"PublicKeyFile": "", # File where public key is stored
"PrivateExchanges": "", # Directory where private exchange public keys are stored
"ProtocolDebug": False, # Turn on protocol level debugging to return detailed information to the requestor
},
},
"iMIP": {
"Enabled": False, # Server-to-iMIP protocol
"Sending": {
"Server": "", # SMTP server to relay messages through
"Port": 587, # SMTP server port to relay messages through
"Address": "", # 'From' address for server
"UseSSL": True,
"Username": "", # For account sending mail
"Password": "", # For account sending mail
"SuppressionDays": 7, # Messages for events older than this may days are not sent
},
"Receiving": {
"Server": "", # Server to retrieve email messages from
"Port": 0, # Server port to retrieve email messages from
"UseSSL": True,
"Type": "", # Type of message access server: 'pop' or 'imap'
"PollingSeconds": 30, # How often to fetch mail
"Username": "", # For account receiving mail
"Password": "", # For account receiving mail
},
"AddressPatterns": [], # Regex patterns to match iMIP-able calendar user addresses
"MailTemplatesDirectory": "/Applications/Server.app/Contents/ServerRoot/usr/share/caldavd/share/email_templates", # Directory containing HTML templates for email invitations (invite.html, cancel.html)
"MailIconsDirectory": "/Applications/Server.app/Contents/ServerRoot/usr/share/caldavd/share/date_icons", # Directory containing language-specific subdirectories containing date-specific icons for email invitations
"InvitationDaysToLive": 90, # How many days invitations are valid
},
"Options": {
"AllowGroupAsOrganizer": False, # Allow groups to be Organizers
"AllowLocationAsOrganizer": False, # Allow locations to be Organizers
"AllowResourceAsOrganizer": False, # Allow resources to be Organizers
"AllowLocationWithoutOrganizer": True, # Allow locations to have events without an Organizer
"AllowResourceWithoutOrganizer": True, # Allow resources to have events without an Organizer
"TrackUnscheduledLocationData": True, # Track who the last modifier of an unscheduled location event is
"TrackUnscheduledResourceData": True, # Track who the last modifier of an unscheduled resource event is
"FakeResourceLocationEmail": False, # Add fake email addresses to work around client bug
"LimitFreeBusyAttendees": 30, # Maximum number of attendees to request freebusy for
"AttendeeRefreshBatch": 5, # Number of attendees to do batched refreshes: 0 - no batching
"AttendeeRefreshCountLimit": 50, # Number of attendees above which attendee refreshes are suppressed: 0 - no limit
"UIDLockTimeoutSeconds": 60, # Time for implicit UID lock timeout
"UIDLockExpirySeconds": 300, # Expiration time for UID lock,
"PrincipalHostAliases": [], # Host names matched in http(s) CUAs
"TimestampAttendeePartStatChanges": True, # Add a time stamp when an Attendee changes their PARTSTAT
"DelegeteRichFreeBusy": True, # Delegates can get extra info in a freebusy request
"RoomResourceRichFreeBusy": True, # Any user can get extra info for rooms/resources in a freebusy request
"AutoSchedule": {
"Enabled": True, # Auto-scheduling will never occur if set to False
"Always": False, # Override augments setting and always auto-schedule
"AllowUsers": False, # Allow auto-schedule for users
"DefaultMode": "automatic", # Default mode for auto-schedule processing, one of:
# "none" - no auto-scheduling
# "accept-always" - always accept, ignore busy time
# "decline-always" - always decline, ignore free time
# "accept-if-free" - accept if free, do nothing if busy
# "decline-if-busy" - decline if busy, do nothing if free
# "automatic" - accept if free, decline if busy
"FutureFreeBusyDays": 3 * 365, # How far into the future to check for booking conflicts
},
"WorkQueues": {
"Enabled": True, # Work queues for scheduling enabled
"RequestDelaySeconds": 5, # Number of seconds delay for a queued scheduling request/cancel
"ReplyDelaySeconds": 1, # Number of seconds delay for a queued scheduling reply
"AutoReplyDelaySeconds": 5, # Time delay for sending an auto reply iTIP message
"AttendeeRefreshBatchDelaySeconds": 5, # Time after an iTIP REPLY for first batched attendee refresh
"AttendeeRefreshBatchIntervalSeconds": 5, # Time between attendee batch refreshes
"TemporaryFailureDelay": 60, # Delay in seconds before a work item is executed again after a temp failure
"MaxTemporaryFailures": 10, # Max number of temp failure retries before treating as a permanent failure
},
#
# This controls automatic splitting of large recurring events by the
# server. The ability for clients to split events using POST
# ?action=split is always enabled
#
"Splitting": {
"Enabled": False, # False for now whilst we experiment with this
"Size": 100 * 1024, # Consider splitting when greater than 100KB
"PastDays": 14, # Number of days in the past where the split will occur
"Delay": 60, # How many seconds to delay the split work item
}
}
},
"FreeBusyURL": {
"Enabled": False, # Per-user free-busy-url protocol
"TimePeriod": 14, # Number of days into the future to generate f-b data if no explicit time-range is specified
"AnonymousAccess": False, # Allow anonymous read access to free-busy URL
},
#
# Notifications
#
"Notifications": {
"Enabled": False,
"CoalesceSeconds": 3,
"Services": {
"APNS": {
"Enabled": False,
"SubscriptionURL": "apns",
"SubscriptionRefreshIntervalSeconds": 2 * 24 * 60 * 60, # How often the client should re-register (2 days)
"SubscriptionPurgeIntervalSeconds": 12 * 60 * 60, # How often a purge is done (12 hours)
"SubscriptionPurgeSeconds": 14 * 24 * 60 * 60, # How old a subscription must be before it's purged (14 days)
"ProviderHost": "gateway.push.apple.com",
"ProviderPort": 2195,
"FeedbackHost": "feedback.push.apple.com",
"FeedbackPort": 2196,
"FeedbackUpdateSeconds": 28800, # 8 hours
"Environment": "PRODUCTION",
"EnableStaggering": False,
"StaggerSeconds": 3,
"CalDAV": {
"Enabled": False,
"CertificatePath": "Certificates/apns:com.apple.calendar.cert.pem",
"PrivateKeyPath": "Certificates/apns:com.apple.calendar.key.pem",
"AuthorityChainPath": "Certificates/apns:com.apple.calendar.chain.pem",
"Passphrase": "",
"KeychainIdentity": "apns:com.apple.calendar",
"Topic": "",
},
"CardDAV": {
"Enabled": False,
"CertificatePath": "Certificates/apns:com.apple.contact.cert.pem",
"PrivateKeyPath": "Certificates/apns:com.apple.contact.key.pem",
"AuthorityChainPath": "Certificates/apns:com.apple.contact.chain.pem",
"Passphrase": "",
"KeychainIdentity": "apns:com.apple.contact",
"Topic": "",
},
},
"AMP": {
"Enabled": False,
"Port": 62311,
"EnableStaggering": False,
"StaggerSeconds": 3,
},
}
},
"DirectoryProxy": {
"Enabled": False,
"SocketPath": "directory-proxy.sock",
"InSidecarCachingSeconds": 120,
},
"DirectoryCaching": {
"CachingSeconds": 60, # How long to cache in worker and in memcached
"NegativeCachingEnabled": True,
"LookupsBetweenPurges": 10000 # 0 = purging turned off
},
#
# Support multiple hosts within a domain
#
"Servers": {
"Enabled": False, # Multiple servers enabled or not
"ConfigFile": "localservers.xml", # File path for server information
"MaxClients": 5, # Pool size for connections between servers
"InboxName": "podding", # Name for top-level inbox resource
"ConduitName": "conduit", # Name for top-level cross-pod resource
},
#
# Performance tuning
#
# Set the maximum number of outstanding requests to this server.
"MaxRequests": 3,
"MaxAccepts": 1,
"MaxDBConnectionsPerPool": 10, # The maximum number of outstanding database
# connections per database connection pool.
# When SharedConnectionPool (see above) is
# set to True, this is the total number of
# outgoing database connections allowed to
# the entire server; when
# SharedConnectionPool is False - this is the
# default - this is the number of database
# connections used per worker process.
"ListenBacklog": 2024,
"IncomingDataTimeOut": 60, # Max. time between request lines
"PipelineIdleTimeOut": 15, # Max. time between pipelined requests
"IdleConnectionTimeOut": 60 * 6, # Max. time for response processing
"CloseConnectionTimeOut": 15, # Max. time for client close
"UIDReservationTimeOut": 30 * 60,
"MaxMultigetWithDataHrefs": 5000,
"MaxQueryWithDataResults": 1000,
# How many results to return for principal search REPORT requests
"MaxPrincipalSearchReportResults": 500,
# How many seconds to wait for principal search REPORT results
"PrincipalSearchReportTimeout": 10,
#
# Client fixes per user-agent match
#
"ClientFixes": {
"ForceAttendeeTRANSP": [
"iOS/8\\.0(\\..*)?",
"iOS/8\\.1(\\..*)?",
"iOS/8\\.2(\\..*)?",
],
},
#
# Localization
#
"Localization": {
"TranslationsDirectory": "/Applications/Server.app/Contents/ServerRoot/usr/share/caldavd/share/translations",
"LocalesDirectory": "locales", # will be relative to DataRoot
"Language": "",
},
#
# Implementation details
#
# The following are specific to how the server is built, and useful
# for development, but shouldn't be needed by users.
#
# Twisted
"Twisted": {
"reactor": "select",
},
# Umask
"umask": 0022,
# A TCP port used for communication between the child and master
# processes (bound to 127.0.0.1). Specify 0 to let OS assign a port.
"ControlPort": 0,