Repository navigation
Expand file tree
/
Copy pathconductor-sync.toml.example
More file actions
211 lines (195 loc) · 9.78 KB
/
Copy pathconductor-sync.toml.example
File metadata and controls
211 lines (195 loc) · 9.78 KB
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
# /etc/conductor-sync/conductor-sync.toml (root:conductor-sync, 0640)
#
# conductor-sync provisions users and groups from Samba AD to Google
# Workspace. This file holds no secret: credentials are named below and
# read from systemd credentials (LoadCredential=) or, for manual runs, from
# credentials_dir (files 0600, owned by the conductor-sync user).
# Guide: docs/usage-p5.md; mapping reference: docs/mapping.md.
#
# Host settings (state, credential names, the Google API endpoints and their
# CA, the CA file path, [api]) live only here. Sync settings (mode, scope,
# mapping, policy, limits, google.customer/admin_subject/member_role,
# schedule.interval) and connection settings (source realm, dcs, preferred,
# dns_servers, ca_pem, bind_user, auth; google requests_per_second,
# max_retries, timeout, marker; alert.webhook_url) can also be edited in
# conductor's "Google Workspace sync" section: each edit is stored as a
# version in the state database and then overrides this file's values for
# those keys (`conductor-sync config export` shows the effective
# configuration, `config import` makes this file's settings the newest
# version again). Secrets set there (the AD bind password, the service
# account key, the webhook secret) are stored encrypted and win over the
# credential files named here.
# "dry-run" plans only (the default for a new installation). Switch to
# "apply" after reviewing the first plan; the first apply is always manual.
mode = "dry-run"
connector = "google"
state_dir = "/var/lib/conductor-sync"
credentials_dir = "/etc/conductor-sync/credentials"
# Prometheus textfile (node_exporter --collector.textfile.directory); empty = off.
metrics_file = ""
# An apply stops after this many failed operations.
max_failures = 25
[source]
realm = "EXAMPLE.COM"
# Optional: fixed DCs instead of DNS SRV discovery, preferred DCs first,
# and the DNS servers that resolve the domain.
dcs = []
preferred = ["dc1.example.com"]
dns_servers = []
ca_file = "/etc/conductor-sync/domain-ca.pem"
# ca_pem = """-----BEGIN CERTIFICATE-----...""" # the CA inline (wins over ca_file)
# A dedicated, unprivileged account: Domain Users can read everything the
# sync needs. Never use an administrator.
bind_user = "svc.sync"
auth = "kerberos" # or "simple" (LDAP simple bind over TLS)
password_credential = "ad-bind" # systemd credential name or absolute 0600 path
# (optional when the password is stored through conductor)
user_bases = ["OU=People,DC=example,DC=com"]
group_bases = ["OU=Google Groups,DC=example,DC=com"]
exclude_bases = ["OU=Service Accounts,OU=People,DC=example,DC=com"]
# Optional: only users that are (nested) members of at least one of these
# groups, and none of the exclude groups (exclusion wins). DN or SID; a SID
# survives renames and moves. (require_group = "<DN>" is the P5 one-group
# form, still accepted.)
include_groups = []
exclude_groups = []
# Accounts past accountExpires count as disabled (suspended on Google).
expired_as_disabled = true
[mapping]
# Tried in order; the first address in allowed_domains wins.
primary_email = ["{mail|lower}", "{sAMAccountName|ascii|lower}@example.com"]
allowed_domains = ["example.com"]
given_name = ["{givenName}", "{displayName}", "{sAMAccountName}"]
family_name = ["{sn}", "{sAMAccountName}"]
default_org_unit = "/"
# Groups are synced only when group_email is set (and group_bases too).
group_email = ["{mail|lower}", "{sAMAccountName|slug}@example.com"]
group_name = ["{cn}"]
group_description = ["{description}"]
group_allowed_domains = ["example.com"]
# Optional fields: only the ones listed are managed (and overwritten).
[mapping.attributes]
title = "{title}"
department = "{department}"
# employee_id = "{employeeID}"
# phone_work = "{telephoneNumber}"
# phone_mobile = "{mobile}"
# Org unit placement. Group rules (group = DN or SID, with an explicit
# priority; 1 is evaluated first) win over container rules (ad = DN; the
# most specific container wins); then default_org_unit. A user matching two
# group rules of the same priority with different targets is a plan error
# for that user (left untouched), never a silent pick. The org units must
# already exist in Google.
# [[mapping.org_units]]
# group = "S-1-5-21-...-1107" # Finance
# target = "/Finance"
# priority = 10
[[mapping.org_units]]
ad = "OU=People,DC=example,DC=com"
target = "/Staff"
[[mapping.org_units]]
ad = "OU=Contractors,OU=People,DC=example,DC=com"
target = "/Contractors"
[policy]
suspend_disabled = true # disabled in AD -> suspended in Google
create_disabled = false # do not create accounts for disabled users
adopt = "never" # "email": list existing accounts and groups with the same address as
# candidates; each is adopted only after `conductor-sync adopt approve`
remove_unmanaged_members = false # keep members of synced groups that the sync does not manage
# Google administrators, privileged AD objects, addresses another AD object
# carries and groups with an admin role are never adopted.
# Adopting an existing Google Workspace (adopt = "email"): what the sync may
# change on accounts and groups that existed before it. The defaults keep an
# adopted account as it was; see docs/mapping.md, "Adopting an existing
# Google Workspace". The sync runs never send a password to an adopted
# account (see [self_service] for what its user may do).
adopted_org_unit = "keep" # or "manage": move it by the org unit rules
adopted_email = "keep" # or "manage": rename it when AD renders another address
adopted_names = "if-set" # or "keep" / "manage": names only when AD has its own value
adopted_attributes = "if-set" # or "keep" / "manage": an empty AD value never clears
adopted_group_members = "add-only" # or "manage": adopted groups never lose a member
# Self-service in conductor ("Connected accounts"): what a signed-in user may
# do with their own account on this target, only on their explicit request
# and with a recent second factor. See docs/self-service.md.
[self_service]
activation = "auto" # or "self-service": an account is created only when its user activates it
password_reset = "created" # or "created-and-adopted" / "off"; administrators are always refused
chosen_password = "off" # or "allow": the user may type a password instead of a generated one
password_min_length = 12 # raises the target's own minimum (8-100)
max_per_user_hour = 3 # activations and password changes per user in any hour
max_per_target_hour = 30 # the same for every user of this target
# Scheduled runs apply only plans inside these limits; otherwise they stop,
# record the plan as blocked and alert. 0 = none allowed, -1 = no limit.
[limits]
max_creates = 50
max_suspends = 10
max_unsuspends = 50
max_renames = 10
max_updates = 500
max_group_changes = 20
max_membership_changes = 1000
max_touched_percent = 10 # of the managed accounts (update/rename/suspend/unsuspend)
min_source_users = 1 # an empty source never means "everybody left"
max_source_drop_percent = 10 # vs. the last applied run
[google]
customer = "my_customer"
# How the service account is authorized (host setting, file only):
# "service-account" (default): it holds a custom admin role of its own and
# impersonates nobody. "domain-wide-delegation" (legacy): the key can
# impersonate any user, super admins included; warned about at every start.
# See docs/google-credentials.md (privileges, scopes, migration, rotation).
auth_mode = "service-account"
# Only with domain-wide delegation: the dedicated administrator to act as.
# admin_subject = "sync-admin@example.com"
# The service account JSON key: set it in conductor (stored encrypted in the
# state database) or with `conductor-sync key set FILE`. A key kept as a
# credential file instead (owned by conductor-sync, 0600, not a symlink):
# key_credential = "google-sa"
# Ownership marker (externalIds customType); one per sync instance and tenant.
# Changing it orphans the accounts marked with the previous value.
marker = "conductor-sync"
requests_per_second = 5
max_retries = 6
timeout = "60s"
member_role = "MEMBER"
[alert]
webhook_url = "" # https (or http to a loopback relay)
webhook_secret_credential = "" # HMAC-SHA256 key for X-Conductor-Signature
[delete]
# conductor-sync delete-user refuses accounts suspended for less than this.
min_suspended_days = 30
[schedule]
# How often scheduled runs happen. With conductor-sync.timer (default) keep
# it equal to the timer's OnUnitInactiveSec: it is used to show the next
# run. in_process = true makes `conductor-sync serve` run them itself
# (hosts without systemd timers); disable the timer then.
interval = "15m"
in_process = false
[api]
# `conductor-sync serve`: the management API for conductor. Under systemd
# the socket comes from conductor-sync-api.socket.
socket = "/run/conductor-sync/api.sock"
# The only peers admitted (SO_PEERCRED).
allowed_users = ["conductor"]
# 32 bytes (raw, hex or base64) that encrypt secrets stored through the API.
state_key_credential = "state-key"
# [google_first]
# The Google-first mode (Google Workspace to AD), off by default; see
# docs/google-first.md. conductor-sync only plans (read-only on both
# sides); conductor applies through conductor-provisioner. A managed OU
# may not overlap source.user_bases or source.group_bases, and a selected
# org unit may not be a target of [mapping].
# enabled = false
# google_domain = "example.com"
#
# [[google_first.scopes]]
# name = "people"
# mode = "dry-run"
# managed_ou = "OU=People,OU=Google,DC=example,DC=com"
# groups_ou = "OU=Groups,OU=People,OU=Google,DC=example,DC=com"
# quarantine_ou = "OU=Quarantine,OU=People,OU=Google,DC=example,DC=com"
# org_units = ["/Staff"]
# sub_org_units = true
# member_of = []
# fields = ["title", "department"]
# logon_template = "{given}.{family}"