summary refs log tree commit diff
path: root/nixos/tests/xmpp/ejabberd.nix
blob: 7926fe80de2fd0b251827db36dddd2e86add50d7 (plain) (blame)
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
import ../make-test-python.nix ({ pkgs, ... }: {
  name = "ejabberd";
  meta = with pkgs.lib.maintainers; {
    maintainers = [ ajs124 ];
  };
  nodes = {
    client = { nodes, pkgs, ... }: {
      networking.extraHosts = ''
        ${nodes.server.config.networking.primaryIPAddress} example.com
      '';

      environment.systemPackages = [
        (pkgs.callPackage ./xmpp-sendmessage.nix { connectTo = nodes.server.config.networking.primaryIPAddress; })
      ];
    };
    server = { config, pkgs, ... }: {
      networking.extraHosts = ''
        ${config.networking.primaryIPAddress} example.com
      '';

      services.ejabberd = {
        enable = true;
        configFile = "/etc/ejabberd.yml";
      };

      environment.etc."ejabberd.yml" = {
        user = "ejabberd";
        mode = "0600";
        text = ''
          loglevel: 3

          hosts:
            - "example.com"

          listen:
            -
              port: 5222
              module: ejabberd_c2s
              zlib: false
              max_stanza_size: 65536
              shaper: c2s_shaper
              access: c2s
            -
              port: 5269
              ip: "::"
              module: ejabberd_s2s_in
            -
              port: 5347
              ip: "127.0.0.1"
              module: ejabberd_service
              access: local
              shaper: fast
            -
              port: 5444
              module: ejabberd_http
              request_handlers:
                "/upload": mod_http_upload

          ## Disabling digest-md5 SASL authentication. digest-md5 requires plain-text
          ## password storage (see auth_password_format option).
          disable_sasl_mechanisms: "digest-md5"

          ## Outgoing S2S options
          ## Preferred address families (which to try first) and connect timeout
          ## in seconds.
          outgoing_s2s_families:
             - ipv4
             - ipv6

          ## auth_method: Method used to authenticate the users.
          ## The default method is the internal.
          ## If you want to use a different method,
          ## comment this line and enable the correct ones.
          auth_method: internal

          ## Store the plain passwords or hashed for SCRAM:
          ## auth_password_format: plain
          auth_password_format: scram

          ###'  TRAFFIC SHAPERS
          shaper:
            # in B/s
            normal: 1000000
            fast: 50000000

          ## This option specifies the maximum number of elements in the queue
          ## of the FSM. Refer to the documentation for details.
          max_fsm_queue: 1000

          ###'   ACCESS CONTROL LISTS
          acl:
            ## The 'admin' ACL grants administrative privileges to XMPP accounts.
            ## You can put here as many accounts as you want.
            admin:
               user:
                 - "root": "example.com"

            ## Local users: don't modify this.
            local:
              user_regexp: ""

            ## Loopback network
            loopback:
              ip:
                - "127.0.0.0/8"
                - "::1/128"
                - "::FFFF:127.0.0.1/128"

          ###'  SHAPER RULES
          shaper_rules:
            ## Maximum number of simultaneous sessions allowed for a single user:
            max_user_sessions: 10
            ## Maximum number of offline messages that users can have:
            max_user_offline_messages:
              - 5000: admin
              - 1024
            ## For C2S connections, all users except admins use the "normal" shaper
            c2s_shaper:
              - none: admin
              - normal
            ## All S2S connections use the "fast" shaper
            s2s_shaper: fast

          ###'  ACCESS RULES
          access_rules:
            ## This rule allows access only for local users:
            local:
              - allow: local
            ## Only non-blocked users can use c2s connections:
            c2s:
              - deny: blocked
              - allow
            ## Only admins can send announcement messages:
            announce:
              - allow: admin
            ## Only admins can use the configuration interface:
            configure:
              - allow: admin
            ## Only accounts of the local ejabberd server can create rooms:
            muc_create:
              - allow: local
            ## Only accounts on the local ejabberd server can create Pubsub nodes:
            pubsub_createnode:
              - allow: local
            ## In-band registration allows registration of any possible username.
            ## To disable in-band registration, replace 'allow' with 'deny'.
            register:
              - allow
            ## Only allow to register from localhost
            trusted_network:
              - allow: loopback

          ## ===============
          ## API PERMISSIONS
          ## ===============
          ##
          ## This section allows you to define who and using what method
          ## can execute commands offered by ejabberd.
          ##
          ## By default "console commands" section allow executing all commands
          ## issued using ejabberdctl command, and "admin access" section allows
          ## users in admin acl that connect from 127.0.0.1 to  execute all
          ## commands except start and stop with any available access method
          ## (ejabberdctl, http-api, xmlrpc depending what is enabled on server).
          ##
          ## If you remove "console commands" there will be one added by
          ## default allowing executing all commands, but if you just change
          ## permissions in it, version from config file will be used instead
          ## of default one.
          ##
          api_permissions:
            "console commands":
              from:
                - ejabberd_ctl
              who: all
              what: "*"

          language: "en"

          ###'  MODULES
          ## Modules enabled in all ejabberd virtual hosts.
          modules:
            mod_adhoc: {}
            mod_announce: # recommends mod_adhoc
              access: announce
            mod_blocking: {} # requires mod_privacy
            mod_caps: {}
            mod_carboncopy: {}
            mod_client_state: {}
            mod_configure: {} # requires mod_adhoc
            ## mod_delegation: {} # for xep0356
            mod_disco: {}
            #mod_irc:
            #  host: "irc.@HOST@"
            #  default_encoding: "utf-8"
            ## mod_bosh: {}
            ## mod_http_fileserver:
            ##   docroot: "/var/www"
            ##   accesslog: "/var/log/ejabberd/access.log"
            mod_http_upload:
              thumbnail: false # otherwise needs the identify command from ImageMagick installed
              put_url: "http://@HOST@:5444/upload"
            ##   # docroot: "@HOME@/upload"
            #mod_http_upload_quota:
            #  max_days: 14
            mod_last: {}
            ## XEP-0313: Message Archive Management
            ## You might want to setup a SQL backend for MAM because the mnesia database is
            ## limited to 2GB which might be exceeded on large servers
            mod_mam: {}
            mod_muc:
              host: "muc.@HOST@"
              access:
                - allow
              access_admin:
                - allow: admin
              access_create: muc_create
              access_persistent: muc_create
            mod_muc_admin: {}
            mod_muc_log: {}
            mod_offline:
              access_max_user_messages: max_user_offline_messages
            mod_ping: {}
            ## mod_pres_counter:
            ##   count: 5
            ##   interval: 60
            mod_privacy: {}
            mod_private: {}
            mod_roster:
                versioning: true
            mod_shared_roster: {}
            mod_stats: {}
            mod_time: {}
            mod_vcard:
              search: false
            mod_vcard_xupdate: {}
            ## Convert all avatars posted by Android clients from WebP to JPEG
            mod_avatar: {}
            #  convert:
            #    webp: jpeg
            mod_version: {}
            mod_stream_mgmt: {}
            ##   The module for S2S dialback (XEP-0220). Please note that you cannot
            ##   rely solely on dialback if you want to federate with other servers,
            ##   because a lot of servers have dialback disabled and instead rely on
            ##   PKIX authentication. Make sure you have proper certificates installed
            ##   and check your accessibility at https://check.messaging.one/
            mod_s2s_dialback: {}
            mod_pubsub:
              plugins:
                - "pep"
            mod_push: {}
        '';
      };

      networking.firewall.enable = false;
    };
  };

  testScript = { nodes, ... }: ''
    ejabberd_prefix = "su ejabberd -s $(which ejabberdctl) "

    server.wait_for_unit("ejabberd.service")

    assert "status: started" in server.succeed(ejabberd_prefix + "status")

    server.succeed(
        ejabberd_prefix + "register azurediamond example.com hunter2",
        ejabberd_prefix + "register cthon98 example.com nothunter2",
    )
    server.fail(ejabberd_prefix + "register asdf wrong.domain")
    client.succeed("send-message")
    server.succeed(
        ejabberd_prefix + "unregister cthon98 example.com",
        ejabberd_prefix + "unregister azurediamond example.com",
    )
  '';
})