Make non-standard SCRAM SHA alogos as opt-in

.github/workflows/main.yml

@@ -13,20 +13,24 @@ jobs:
       run: |-
         sudo apt-get update && sudo apt-get install --no-install-recommends -qq -y build-essential \
         ccache meson libglib2.0-dev glib-networking telepathy-gabble libsasl2-dev libxml2-dev \
-        libsoup2.4-dev libsasl2-modules-gssapi-mit gnutls-bin libsqlite3-dev libssl-dev libgnutls28-dev
+        libsoup2.4-dev libsasl2-modules-gssapi-mit libsqlite3-dev libssl-dev libgnutls28-dev \
+        gnutls-bin gobject-introspection libgirepository1.0-dev gtk-doc-tools
     - name: Bootstrap
-      run: meson _b
+      run: meson _b -Dgoogle-relay=true -Dintrospection=enabled -Dgtk_doc=true -Dnonstandard-scram=true
     - name: Syntax
       run: ninja -C _b check
     - name: Build
       run: ninja -C _b
     - name: Run tests
       run: meson test -C _b
+    - name: Build docs
+      run: ninja -C _b wocky-doc
     - name: Artifacts
       uses: actions/upload-artifact@v2
       with:
-        name: Reports
-        path: _b/meson-logs/
+        path: |
+          _b/meson-logs/
+          _b/docs/
 
   build-autotools:
     runs-on: ubuntu-latest

docs/reference/meson.build

@@ -0,0 +1,13 @@
+
+gnome.gtkdoc(meson.project_name(),
+  main_sgml: 'wocky-docs.sgml',
+  dependencies: wocky_dep,
+  src_dir: [
+    meson.current_build_dir()/'..'/'..'/'wocky',
+    meson.current_source_dir()/'..'/'..'/'wocky',
+  ],
+  namespace: 'wocky',
+  mkdb_args: [ '--sgml-mode', '--output-format=xml'],
+  scan_args: ['--rebuild-types', '--rebuild-sections'],
+  install: true
+)

docs/reference/wocky-docs.sgml

@@ -1,10 +1,10 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+               "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"
 [
   <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 ]>
-<book id="index">
+<book id="index" lang="en" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
     <title>Wocky Reference Manual</title>
   </bookinfo>
@@ -18,12 +18,15 @@
     <xi:include href="xml/wocky-c2s-porter.xml"/>
     <xi:include href="xml/wocky-caps-cache.xml"/>
     <xi:include href="xml/wocky-caps-hash.xml"/>
+    <xi:include href="xml/wocky-xep-0115-capabilities.xml"/>
     <xi:include href="xml/wocky-connector.xml"/>
     <xi:include href="xml/wocky-contact-factory.xml"/>
     <xi:include href="xml/wocky-contact.xml"/>
+    <xi:include href="xml/wocky-ll-connection-factory.xml"/>
+    <xi:include href="xml/wocky-ll-connector.xml"/>
+    <xi:include href="xml/wocky-ll-contact.xml"/>
     <xi:include href="xml/wocky-data-form.xml"/>
     <xi:include href="xml/wocky-debug.xml"/>
-    <xi:include href="xml/wocky-enumtypes.xml"/>
     <xi:include href="xml/wocky.xml"/>
     <xi:include href="xml/wocky-heartbeat-source.xml"/>
     <xi:include href="xml/wocky-disco-identity.xml"/>
@@ -61,6 +64,7 @@
     <xi:include href="xml/wocky-xmpp-reader.xml"/>
     <xi:include href="xml/wocky-xmpp-writer.xml"/>
 
+    <xi:include href="xml/wocky-google-relay.xml"/>
     <xi:include href="xml/wocky-jingle-content.xml"/>
     <xi:include href="xml/wocky-jingle-factory.xml"/>
     <xi:include href="xml/wocky-jingle-info-internal.xml"/>
@@ -72,6 +76,8 @@
     <xi:include href="xml/wocky-jingle-transport-iface.xml"/>
     <xi:include href="xml/wocky-jingle-transport-rawudp.xml"/>
     <xi:include href="xml/wocky-jingle-types.xml"/>
+
+    <xi:include href="xml/wocky-loopback-stream.xml"/>
   </chapter>
 
   <chapter id="object-tree">
@@ -83,6 +89,18 @@
     <title>API Index</title>
     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
   </index>
+  <index id="new-api-0.19.0">
+    <title>Index of new symbols in 0.19.0</title>
+    <xi:include href="xml/api-index-0.19.0.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="new-api-0.7.27">
+    <title>Index of new symbols in 0.7.27</title>
+    <xi:include href="xml/api-index-0.7.27.xml"><xi:fallback /></xi:include>
+  </index>
+  <index id="new-api-0.5.14">
+    <title>Index of new symbols in 0.5.14</title>
+    <xi:include href="xml/api-index-0.5.14.xml"><xi:fallback /></xi:include>
+  </index>
 
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
 </book>

meson.build

@@ -109,6 +109,10 @@ if get_option('debug')
   defines += 'ENABLE_DEBUG'
 endif
 
+if get_option('nonstandard-scram')
+  defines += 'WOCKY_SCRAM_NONSTANDARD'
+endif
+
 if get_option('google-relay')
   defines += 'ENABLE_GOOGLE_RELAY'
 endif
@@ -170,3 +174,7 @@ if get_option('code-style-check')
     shell, meson.source_root()/'tools'/'check-c-style.sh', wocky_check_files
   ])
 endif
+
+if get_option('gtk_doc')
+  subdir('docs/reference')
+endif

meson_options.txt

@@ -1,6 +1,7 @@
-option('gtk_doc', type: 'boolean', value: false, description: 'Enable Gtk-Doc generation')
-option('introspection', type: 'feature', value: 'auto', description: 'Build Introspection data')
-option('code-style-check', type: 'boolean', description: 'enable coding style checks')
+option('gtk_doc', type: 'boolean', value: false, description: 'Enable Gtk-Doc generation', yield: true)
+option('introspection', type: 'feature', value: 'auto', description: 'Build Introspection data', yield: true)
+option('code-style-check', type: 'boolean', description: 'enable coding style checks', yield: true)
 option('install-headers', type: 'string', description: 'install development headers here')
 option('libdir-suffix', type: 'string', description: 'install a shared library into project-specific subdir')
-option('google-relay', type: 'boolean', value: false, description: 'enable google jingle relay support')
+option('google-relay', type: 'boolean', value: false, description: 'enable google jingle relay support', yield: true)
+option('nonstandard-scram', type: 'boolean', value: false, description: 'enable non-standard scram methods', yield: true)

tests/Makefile.am

@@ -88,6 +88,7 @@ TEST_PROGS = \
   wocky-session-test \
   wocky-stanza-test \
   wocky-tls-test \
+  wocky-sm-test \
   wocky-utils-test \
   wocky-xmpp-connection-test \
   wocky-xmpp-node-test \
@@ -229,6 +230,19 @@ wocky_tls_test_SOURCES = \
   wocky-test-stream.c wocky-test-stream.h
 wocky_tls_test_CFLAGS = $(AM_CFLAGS) $(TLSDEFS)
 
+EXTRA_wocky_sm_test_DEPENDENCIES = $(CA_DIR) certs
+wocky_sm_test_SOURCES = \
+   wocky-sm-test.c \
+   wocky-test-sasl-auth-server.c \
+   wocky-test-sasl-auth-server.h \
+   wocky-test-connector-server.c \
+   wocky-test-connector-server.h \
+   wocky-test-helper.c wocky-test-helper.h \
+   wocky-test-stream.c wocky-test-stream.h \
+   test-resolver.c test-resolver.h
+wocky_sm_test_LDADD = $(LDADD) @LIBSASL2_LIBS@
+wocky_sm_test_CFLAGS = $(AM_CFLAGS) @LIBSASL2_CFLAGS@ $(TLSDEFS)
+
 wocky_utils_test_SOURCES = wocky-utils-test.c
 
 wocky_xmpp_connection_test_SOURCES = \
@@ -297,7 +311,7 @@ test-%: wocky-%-test
 .PHONY: test test-report
 
 include $(top_srcdir)/tools/check-coding-style.mk
-check-local: test check-coding-style
+check-local: check-coding-style test
 
 ############################################################################
 

tests/meson.build

@@ -144,6 +144,16 @@ tests = {
     'wocky-test-stream.c', 'wocky-test-stream.h',
     'wocky-tls-test.c',
   ],
+  'wocky-sm-test': [
+    'wocky-test-sasl-auth-server.c',
+    'wocky-test-sasl-auth-server.h',
+    'wocky-test-connector-server.c',
+    'wocky-test-connector-server.h',
+    'wocky-test-helper.c', 'wocky-test-helper.h',
+    'wocky-test-stream.c', 'wocky-test-stream.h',
+    'test-resolver.c', 'test-resolver.h',
+    'wocky-sm-test.c',
+  ],
   'wocky-utils-test': [
     'wocky-utils-test.c',
   ],

tests/wocky-connector-test.c

@@ -74,6 +74,12 @@
 #define DEFAULT_SASL_MECH "SCRAM-SHA-1"
 #endif
 
+#ifdef WOCKY_SCRAM_NONSTANDARD
+#define BINDING_SCRAM_MECH "SCRAM-SHA-512-PLUS"
+#else
+#define BINDING_SCRAM_MECH "SCRAM-SHA-256-PLUS"
+#endif
+
 #define PORT_XMPP 5222
 #define PORT_NONE 0
 
@@ -944,7 +950,7 @@ test_t tests[] =
      { "/connector/auth/sasl/binding",
       NOISY,
       { S_NO_ERROR },
-      { { TLS, "SCRAM-SHA-512-PLUS" },
+      { { TLS, BINDING_SCRAM_MECH },
         { SERVER_PROBLEM_NO_PROBLEM, CONNECTOR_OK },
         { "moose", "something" },
         PORT_XMPP },
@@ -956,7 +962,7 @@ test_t tests[] =
      { "/connector/auth/sasl/bad-binding-data",
       NOISY,
       { S_WOCKY_AUTH_ERROR, WOCKY_AUTH_ERROR_FAILURE, -1 },
-      { { TLS, "SCRAM-SHA-512-PLUS" },
+      { { TLS, BINDING_SCRAM_MECH },
         { SERVER_PROBLEM_MANGLED_BINDING_DATA, CONNECTOR_OK },
         { "moose", "something" },
         PORT_XMPP },
@@ -968,7 +974,7 @@ test_t tests[] =
      { "/connector/auth/sasl/bad-binding-flag",
       NOISY,
       { S_WOCKY_AUTH_ERROR, WOCKY_AUTH_ERROR_FAILURE, -1 },
-      { { TLS, "SCRAM-SHA-512-PLUS" },
+      { { TLS, BINDING_SCRAM_MECH },
         { SERVER_PROBLEM_MANGLED_BINDING_FLAG, CONNECTOR_OK },
         { "moose", "something" },
         PORT_XMPP },
@@ -980,7 +986,7 @@ test_t tests[] =
      { "/connector/auth/sasl/scrambled-binding",
       NOISY,
       { S_WOCKY_AUTH_ERROR, WOCKY_AUTH_ERROR_INVALID_REPLY, -1 },
-      { { TLS, "SCRAM-SHA-512-PLUS" },
+      { { TLS, BINDING_SCRAM_MECH },
         { SERVER_PROBLEM_SCRAMBLED_BINDING, CONNECTOR_OK },
         { "moose", "something" },
         PORT_XMPP },