Merge pull request #551 from jdreichmann/feat-mx-puppet-instagram

Add mx-puppet-instagram

README.md

@@ -52,6 +52,8 @@ Using this playbook, you can get the following services configured on your serve
 
 - (optional) the [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) bridge for slack compatible webhooks ([ConcourseCI](https://concourse-ci.org/), [Slack](https://slack.com/) etc. pp.)
 
+- (optional) the [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) bridge for Instagram-DMs ([Instagram](https://www.instagram.com/)) - see [docs/configuring-playbook-bridge-mx-puppet-instagram.md](docs/configuring-playbook-bridge-mx-puppet-instagram.md) for setup documentation
+
 - (optional) the [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) for bridging your Matrix server to SMS
 
 - (optional) [Email2Matrix](https://github.com/devture/email2matrix) for relaying email messages to Matrix rooms

docs/configuring-playbook-bridge-mx-puppet-instagram.md

@@ -0,0 +1,36 @@
+# Setting up mx-puppet-instagram (optional)
+
+The playbook can install and configure
+[mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) for you.
+
+This allows you to bridge Instagram DirectMessages into Matrix.
+
+To enable the [Instagram](https://www.instagram.com/) bridge just use the following
+playbook configuration:
+
+
+```yaml
+matrix_mx_puppet_instagram_enabled: true
+```
+
+
+## Usage
+
+Once the bot is enabled, you need to start a chat with `Instagram Puppet Bridge` with
+the handle `@_instagrampuppet_bot:YOUR_DOMAIN` (where `YOUR_DOMAIN` is your base
+domain, not the `matrix.` domain).
+
+Send `link <username> <password>` to the bridge bot to link your instagram account.
+
+The `list` commands shows which accounts are linked and which `puppetId` is associated.
+
+For double-puppeting, you probably want to issue these commands:
+
+- `settype $puppetId puppet` to enable puppeting for the link (instead of relaying)
+- `setautoinvite $puppetId 1` to automatically invite you to chats
+- `setmatrixtoken $accessToken` to set the access token to enable puppeting from the other side (the "double" in double puppeting)
+
+If you are linking only one Instagram account, your `$puppetId` is probably 1, but use the `list` command find out.
+
+The `help` command shows which commands are available, though at the time of writing, not every command is fully implemented.
+

group_vars/matrix_servers

@@ -394,6 +394,37 @@ matrix_mx_puppet_slack_login_shared_secret: "{{ matrix_synapse_ext_password_prov
 ######################################################################
 
 
+######################################################################
+#
+# matrix-bridge-mx-puppet-instagram
+#
+######################################################################
+
+# We don't enable bridges by default.
+matrix_mx_puppet_instagram_enabled: false
+
+matrix_mx_puppet_instagram_container_image_self_build: "{{ matrix_architecture != 'amd64'}}"
+
+matrix_mx_puppet_instagram_systemd_required_services_list: |
+  {{
+    ['docker.service']
+    +
+    (['matrix-synapse.service'] if matrix_synapse_enabled else [])
+  }}
+
+matrix_mx_puppet_instagram_appservice_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.as.tok') | to_uuid }}"
+
+matrix_mx_puppet_instagram_homeserver_token: "{{ matrix_synapse_macaroon_secret_key | password_hash('sha512', 'mxig.hs.tok') | to_uuid }}"
+
+matrix_mx_puppet_instagram_login_shared_secret: "{{ matrix_synapse_ext_password_provider_shared_secret_auth_shared_secret if matrix_synapse_ext_password_provider_shared_secret_auth_enabled else '' }}"
+
+######################################################################
+#
+# /matrix-bridge-mx-puppet-instagram
+#
+######################################################################
+
+
 ######################################################################
 #
 # matrix-corporal

roles/matrix-bridge-mx-puppet-instagram/defaults/main.yml

@@ -0,0 +1,86 @@
+# mx-puppet-instagram bridges instagram DMs
+# See: https://github.com/Sorunome/mx-puppet-instagram
+
+matrix_mx_puppet_instagram_enabled: true
+
+matrix_mx_puppet_instagram_container_image_self_build: false
+
+matrix_mx_puppet_instagram_docker_image: "docker.io/sorunome/mx-puppet-instagram:latest"
+matrix_mx_puppet_instagram_docker_image_force_pull: "{{ matrix_mx_puppet_instagram_docker_image.endswith(':latest') }}"
+
+matrix_mx_puppet_instagram_base_path: "{{ matrix_base_data_path }}/mx-puppet-instagram"
+matrix_mx_puppet_instagram_config_path: "{{ matrix_mx_puppet_instagram_base_path }}/config"
+matrix_mx_puppet_instagram_data_path: "{{ matrix_mx_puppet_instagram_base_path }}/data"
+matrix_mx_puppet_instagram_docker_src_files_path: "{{ matrix_mx_puppet_instagram_base_path }}/docker-src"
+
+matrix_mx_puppet_instagram_appservice_port: "8440"
+matrix_mx_puppet_instagram_homeserver_address: 'http://matrix-synapse:8008'
+matrix_mx_puppet_instagram_homeserver_domain: '{{ matrix_domain }}'
+matrix_mx_puppet_instagram_appservice_address: 'http://matrix-mx-puppet-instagram:{{ matrix_mx_puppet_instagram_appservice_port }}'
+
+# "@user:server.com" to allow specific user
+# "@.*:yourserver.com" to allow users on a specific homeserver
+# "@.*" to allow anyone
+matrix_mx_puppet_instagram_provisioning_whitelist:
+  - "@.*:{{ matrix_domain|regex_escape }}"
+
+# Leave empty to disable blacklist
+# "@user:server.com" disallow a specific user
+# "@.*:yourserver.com" disallow users on a specific homeserver
+matrix_mx_puppet_instagram_provisioning_blacklist: []
+
+# A list of extra arguments to pass to the container
+matrix_mx_puppet_instagram_container_extra_arguments: []
+
+# List of systemd services that matrix-puppet-instagram.service depends on.
+matrix_mx_puppet_instagram_systemd_required_services_list: ['docker.service']
+
+# List of systemd services that matrix-puppet-instagram.service wants
+matrix_mx_puppet_instagram_systemd_wanted_services_list: []
+
+matrix_mx_puppet_instagram_appservice_token: ''
+matrix_mx_puppet_instagram_homeserver_token: ''
+
+# Can be set to enable automatic double-puppeting via Shared Secret Auth (https://github.com/devture/matrix-synapse-shared-secret-auth).
+matrix_mx_puppet_instagram_login_shared_secret: ''
+
+# Default configuration template which covers the generic use case.
+# You can customize it by controlling the various variables inside it.
+#
+# For a more advanced customization, you can extend the default (see `matrix_mx_puppet_instagram_configuration_extension_yaml`)
+# or completely replace this variable with your own template.
+matrix_mx_puppet_instagram_configuration_yaml: "{{ lookup('template', 'templates/config.yaml.j2') }}"
+
+matrix_mx_puppet_instagram_configuration_extension_yaml: |
+  # Your custom YAML configuration goes here.
+  # This configuration extends the default starting configuration (`matrix_mx_puppet_instagram_configuration_yaml`).
+  #
+  # You can override individual variables from the default configuration, or introduce new ones.
+  #
+  # If you need something more special, you can take full control by
+  # completely redefining `matrix_mx_puppet_instagram_configuration_yaml`.
+
+matrix_mx_puppet_instagram_configuration_extension: "{{ matrix_mx_puppet_instagram_configuration_extension_yaml|from_yaml if matrix_mx_puppet_instagram_configuration_extension_yaml|from_yaml is mapping else {} }}"
+
+# Holds the final configuration (a combination of the default and its extension).
+# You most likely don't need to touch this variable. Instead, see `matrix_mx_puppet_instagram_configuration_yaml`.
+matrix_mx_puppet_instagram_configuration: "{{ matrix_mx_puppet_instagram_configuration_yaml|from_yaml|combine(matrix_mx_puppet_instagram_configuration_extension, recursive=True) }}"
+
+matrix_mx_puppet_instagram_registration_yaml: |
+  as_token: "{{ matrix_mx_puppet_instagram_appservice_token }}"
+  hs_token: "{{ matrix_mx_puppet_instagram_homeserver_token }}"
+  id: instagram-puppet
+  namespaces:
+    users:
+      - exclusive: true
+        regex: '@_instagrampuppet_.*:{{ matrix_mx_puppet_instagram_homeserver_domain|regex_escape }}'
+    rooms: []
+    aliases:
+      - exclusive: true
+        regex: '#_instagrampuppet_.*:{{ matrix_mx_puppet_instagram_homeserver_domain|regex_escape }}'
+  protocols: []
+  rate_limited: false
+  sender_localpart: _instagrampuppet_bot
+  url: {{ matrix_mx_puppet_instagram_appservice_address }}
+
+matrix_mx_puppet_instagram_registration: "{{ matrix_mx_puppet_instagram_registration_yaml|from_yaml }}"

roles/matrix-bridge-mx-puppet-instagram/tasks/init.yml

@@ -0,0 +1,17 @@
+- set_fact:
+    matrix_systemd_services_list: "{{ matrix_systemd_services_list + ['matrix-mx-puppet-instagram'] }}"
+  when: matrix_mx_puppet_instagram_enabled|bool
+
+# If the matrix-synapse role is not used, these variables may not exist.
+- set_fact:
+    matrix_synapse_container_extra_arguments: >
+      {{ matrix_synapse_container_extra_arguments|default([]) }}
+      +
+      ["--mount type=bind,src={{ matrix_mx_puppet_instagram_config_path }}/registration.yaml,dst=/matrix-mx-puppet-instagram-registration.yaml,ro"]
+
+    matrix_synapse_app_service_config_files: >
+      {{ matrix_synapse_app_service_config_files|default([]) }}
+      +
+      {{ ["/matrix-mx-puppet-instagram-registration.yaml"] }}
+  when: matrix_mx_puppet_instagram_enabled|bool
+

roles/matrix-bridge-mx-puppet-instagram/tasks/main.yml

@@ -0,0 +1,21 @@
+- import_tasks: "{{ role_path }}/tasks/init.yml"
+  tags:
+    - always
+
+- import_tasks: "{{ role_path }}/tasks/validate_config.yml"
+  when: "run_setup|bool and matrix_mx_puppet_instagram_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-instagram
+
+- import_tasks: "{{ role_path }}/tasks/setup_install.yml"
+  when: "run_setup|bool and matrix_mx_puppet_instagram_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-instagram
+
+- import_tasks: "{{ role_path }}/tasks/setup_uninstall.yml"
+  when: "run_setup|bool and not matrix_mx_puppet_instagram_enabled|bool"
+  tags:
+    - setup-all
+    - setup-mx-puppet-instagram

roles/matrix-bridge-mx-puppet-instagram/tasks/setup_install.yml

@@ -0,0 +1,78 @@
+---
+
+# If the matrix-synapse role is not used, `matrix_synapse_role_executed` won't exist.
+# We don't want to fail in such cases.
+- name: Fail if matrix-synapse role already executed
+  fail:
+    msg: >-
+      The matrix-bridge-mx-puppet-instagram role needs to execute before the matrix-synapse role.
+  when: "matrix_synapse_role_executed|default(False)"
+
+- name: Ensure mx-puppet-instagram image is pulled
+  docker_image:
+    name: "{{ matrix_mx_puppet_instagram_docker_image }}"
+    source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
+    force_source: "{{ matrix_mx_puppet_instagram_docker_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}"
+    force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_mx_puppet_instagram_docker_image_force_pull }}"
+  when: matrix_mx_puppet_instagram_enabled|bool and not matrix_mx_puppet_instagram_container_image_self_build
+
+- name: Ensure mx-puppet-instagram paths exist
+  file:
+    path: "{{ item.path }}"
+    state: directory
+    mode: 0750
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+  with_items:
+    - { path: "{{ matrix_mx_puppet_instagram_base_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_instagram_config_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_instagram_data_path }}", when: true }
+    - { path: "{{ matrix_mx_puppet_instagram_docker_src_files_path }}", when: "{{ matrix_mx_puppet_instagram_container_image_self_build }}" }
+  when: matrix_mx_puppet_instagram_enabled|bool and item.when|bool
+
+- name: Ensure mx-puppet-instagram repository is present on self build
+  git:
+    repo: https://github.com/Sorunome/mx-puppet-instagram.git
+    dest: "{{ matrix_mx_puppet_instagram_docker_src_files_path }}"
+    force: "yes"
+  when: "matrix_mx_puppet_instagram_enabled|bool and matrix_mx_puppet_instagram_container_image_self_build"
+
+- name: Ensure mx-puppet-instagram Docker image is built
+  docker_image:
+    name: "{{ matrix_mx_puppet_instagram_docker_image }}"
+    source: build
+    build:
+      dockerfile: Dockerfile
+      path: "{{ matrix_mx_puppet_instagram_docker_src_files_path }}"
+      pull: yes
+  when: "matrix_mx_puppet_instagram_enabled|bool and matrix_mx_puppet_instagram_container_image_self_build"
+
+- name: Ensure mx-puppet-instagram config.yaml installed
+  copy:
+    content: "{{ matrix_mx_puppet_instagram_configuration|to_nice_yaml }}"
+    dest: "{{ matrix_mx_puppet_instagram_config_path }}/config.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure mx-puppet-instagram-registration.yaml installed
+  copy:
+    content: "{{ matrix_mx_puppet_instagram_registration|to_nice_yaml }}"
+    dest: "{{ matrix_mx_puppet_instagram_config_path }}/registration.yaml"
+    mode: 0644
+    owner: "{{ matrix_user_username }}"
+    group: "{{ matrix_user_groupname }}"
+
+- name: Ensure matrix-mx-puppet-instagram.service installed
+  template:
+    src: "{{ role_path }}/templates/systemd/matrix-mx-puppet-instagram.service.j2"
+    dest: "/etc/systemd/system/matrix-mx-puppet-instagram.service"
+    mode: 0644
+  register: matrix_mx_puppet_instagram_systemd_service_result
+
+- name: Ensure systemd reloaded after matrix-mx-puppet-instagram.service installation
+  service:
+    daemon_reload: yes
+  when: "matrix_mx_puppet_instagram_systemd_service_result.changed"
+
+

roles/matrix-bridge-mx-puppet-instagram/tasks/setup_uninstall.yml

@@ -0,0 +1,24 @@
+---
+
+- name: Check existence of matrix-mx-puppet-instagram service
+  stat:
+    path: "/etc/systemd/system/matrix-mx-puppet-instagram.service"
+  register: matrix_mx_puppet_instagram_service_stat
+
+- name: Ensure matrix-mx-puppet-instagram is stopped
+  service:
+    name: matrix-mx-puppet-instagram
+    state: stopped
+    daemon_reload: yes
+  when: "matrix_mx_puppet_instagram_service_stat.stat.exists"
+
+- name: Ensure matrix-mx-puppet-instagram.service doesn't exist
+  file:
+    path: "/etc/systemd/system/matrix-mx-puppet-instagram.service"
+    state: absent
+  when: "matrix_mx_puppet_instagram_service_stat.stat.exists"
+
+- name: Ensure systemd reloaded after matrix-mx-puppet-instagram.service removal
+  service:
+    daemon_reload: yes
+  when: "matrix_mx_puppet_instagram_service_stat.stat.exists"

roles/matrix-bridge-mx-puppet-instagram/tasks/validate_config.yml

@@ -0,0 +1,10 @@
+---
+
+- name: Fail if required settings not defined
+  fail:
+    msg: >-
+      You need to define a required configuration setting (`{{ item }}`).
+  when: "vars[item] == ''"
+  with_items:
+    - "matrix_mx_puppet_instagram_appservice_token"
+    - "matrix_mx_puppet_instagram_homeserver_token"

roles/matrix-bridge-mx-puppet-instagram/templates/config.yaml.j2

@@ -0,0 +1,82 @@
+#jinja2: lstrip_blocks: "True"
+bridge:
+  # Port to host the bridge on
+  # Used for communication between the homeserver and the bridge
+  port: {{ matrix_mx_puppet_instagram_appservice_port }}
+  # The host connections to the bridge's webserver are allowed from
+  bindAddress: 0.0.0.0
+  # Public domain of the homeserver
+  domain: {{ matrix_mx_puppet_instagram_homeserver_domain }}
+  # Reachable URL of the Matrix homeserver
+  homeserverUrl: {{ matrix_mx_puppet_instagram_homeserver_address }}
+  {% if matrix_mx_puppet_instagram_login_shared_secret != '' %}
+  loginSharedSecretMap:
+    {{ matrix_domain }}: {{ matrix_mx_puppet_instagram_login_shared_secret }}
+  {% endif %}
+
+presence:
+  # Bridge Instagram online/offline status
+  enabled: true
+  # How often to send status to the homeserver in milliseconds
+  interval: 500
+
+provisioning:
+  # Regex of Matrix IDs allowed to use the puppet bridge
+  whitelist: {{ matrix_mx_puppet_instagram_provisioning_whitelist|to_json }}
+    # Allow a specific user
+    #- "@user:server\\.com"
+    # Allow users on a specific homeserver
+    #- "@.*:yourserver\\.com"
+    # Allow anyone
+    #- ".*"
+  # Regex of Matrix IDs forbidden from using the puppet bridge
+  #blacklist:
+    # Disallow a specific user
+    #- "@user:server\\.com"
+    # Disallow users on a specific homeserver
+    #- "@.*:yourserver\\.com"
+  blacklist: {{ matrix_mx_puppet_instagram_provisioning_blacklist|to_json }}
+
+  # Shared secret for the provisioning API for use by integration managers.
+  # If this is not set, the provisioning API will not be enabled.
+  #sharedSecret: random string
+  # Path prefix for the provisioning API. /v1 will be appended to the prefix automatically.
+  apiPrefix: /_matrix/provision
+
+database:
+  # Use Postgres as a database backend
+  # If set, will be used instead of SQLite3
+  # Connection string to connect to the Postgres instance
+  # with username "user", password "pass", host "localhost" and database name "dbname".
+  # Modify each value as necessary
+  #connString: "postgres://user:pass@localhost/dbname?sslmode=disable"
+  # Use SQLite3 as a database backend
+  # The name of the database file
+  filename: /data/database.db
+
+logging:
+  # Log level of console output
+  # Allowed values starting with most verbose:
+  # silly, debug, verbose, info, warn, error
+  console: info
+  # Date and time formatting
+  lineDateFormat: MMM-D HH:mm:ss.SSS
+  # Logging files
+  # Log files are rotated daily by default
+  files:
+    # Log file path
+    - file: "/data/bridge.log"
+      # Log level for this file
+      # Allowed values starting with most verbose:
+      # silly, debug, verbose, info, warn, error
+      level: info
+      # Date and time formatting
+      datePattern: YYYY-MM-DD
+      # Maximum number of logs to keep.
+      # This can be a number of files or number of days.
+      # If using days, add 'd' as a suffix
+      maxFiles: 14d
+      # Maximum size of the file after which it will rotate. This can be a
+      # number of bytes, or units of kb, mb, and gb. If using the units, add
+      # 'k', 'm', or 'g' as the suffix
+      maxSize: 50m

roles/matrix-bridge-mx-puppet-instagram/templates/systemd/matrix-mx-puppet-instagram.service.j2

@@ -0,0 +1,41 @@
+#jinja2: lstrip_blocks: "True"
+[Unit]
+Description=Matrix mx-puppet-instagram bridge
+{% for service in matrix_mx_puppet_instagram_systemd_required_services_list %}
+Requires={{ service }}
+After={{ service }}
+{% endfor %}
+{% for service in matrix_mx_puppet_instagram_systemd_wanted_services_list %}
+Wants={{ service }}
+{% endfor %}
+
+[Service]
+Type=simple
+ExecStartPre=-{{ matrix_host_command_docker }} kill matrix-mx-puppet-instagram
+ExecStartPre=-{{ matrix_host_command_docker }} rm matrix-mx-puppet-instagram
+
+# Intentional delay, so that the homeserver (we likely depend on) can manage to start.
+ExecStartPre={{ matrix_host_command_sleep }} 5
+
+ExecStart={{ matrix_host_command_docker }} run --rm --name matrix-mx-puppet-instagram \
+			--log-driver=none \
+			--user={{ matrix_user_uid }}:{{ matrix_user_gid }} \
+			--cap-drop=ALL \
+			--network={{ matrix_docker_network }} \
+			-e CONFIG_PATH=/config/config.yaml \
+			-e REGISTRATION_PATH=/config/registration.yaml \
+			-v {{ matrix_mx_puppet_instagram_config_path }}:/config:z \
+			-v {{ matrix_mx_puppet_instagram_data_path }}:/data:z \
+			{% for arg in matrix_mx_puppet_instagram_container_extra_arguments %}
+			{{ arg }} \
+			{% endfor %}
+			{{ matrix_mx_puppet_instagram_docker_image }}
+
+ExecStop=-{{ matrix_host_command_docker }} kill matrix-mx-puppet-instagram
+ExecStop=-{{ matrix_host_command_docker }} rm matrix-mx-puppet-instagram
+Restart=always
+RestartSec=30
+SyslogIdentifier=matrix-mx-puppet-instagram
+
+[Install]
+WantedBy=multi-user.target

setup.yml

@@ -18,6 +18,7 @@
     - matrix-bridge-mautrix-whatsapp
     - matrix-bridge-mx-puppet-skype
     - matrix-bridge-mx-puppet-slack
+    - matrix-bridge-mx-puppet-instagram
     - matrix-bridge-sms
     - matrix-synapse
     - matrix-riot-web