Add Mjolnir module and update workflow

Signed-off-by: Tommy <contact@tommytran.io>
This commit is contained in:
Tommy 2022-12-04 17:09:15 -05:00
parent 2c8d9530c1
commit 6de9471453
No known key found for this signature in database
GPG Key ID: 060B29EB996BD9F2
5 changed files with 30 additions and 30 deletions

View File

@ -1,4 +1,4 @@
name: build name: Build
on: on:
workflow_dispatch: workflow_dispatch:
@ -9,12 +9,12 @@ on:
paths-ignore: paths-ignore:
- '**.md' - '**.md'
schedule: schedule:
# Build the image regularly (each Friday) # Build the image regularly (each Saturday)
- cron: '13 21 * * 5' - cron: '0 22 * * 6'
env: env:
REGISTRY: ghcr.io REGISTRY: ghcr.io
IMAGE_NAME: wonderfall/synapse IMAGE_NAME: tommytran732/synapse
jobs: jobs:
build: build:

View File

@ -1,14 +1,14 @@
name: scan name: Scan
on: on:
schedule: schedule:
# Scan the image regularly (once a day) # Scan the image regularly (once a day)
- cron: '45 03 * * *' - cron: '0 23 * * *'
jobs: jobs:
build: scan:
name: Scan current image & report results name: Scan current image & report results
runs-on: "ubuntu-20.04" runs-on: "ubuntu-latest"
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v2 uses: actions/checkout@v2
@ -16,7 +16,7 @@ jobs:
- name: Run Trivy vulnerability scanner - name: Run Trivy vulnerability scanner
uses: aquasecurity/trivy-action@master uses: aquasecurity/trivy-action@master
with: with:
image-ref: 'ghcr.io/wonderfall/synapse' image-ref: 'ghcr.io/tommytran732/synapse'
format: 'template' format: 'template'
template: '@/contrib/sarif.tpl' template: '@/contrib/sarif.tpl'
output: 'trivy-results.sarif' output: 'trivy-results.sarif'

View File

@ -1,17 +1,15 @@
ARG SYNAPSE_VERSION=1.75.0 ARG SYNAPSE_VERSION=1.75.0
ARG PYTHON_VERSION=3.11
ARG ALPINE_VERSION=3.17
ARG HARDENED_MALLOC_VERSION=11 ARG HARDENED_MALLOC_VERSION=11
ARG UID=991 ARG UID=991
ARG GID=991 ARG GID=991
### Build Hardened Malloc ### Build Hardened Malloc
FROM alpine:${ALPINE_VERSION} as build-malloc FROM alpine:latest as build-malloc
ARG HARDENED_MALLOC_VERSION ARG HARDENED_MALLOC_VERSION
ARG CONFIG_NATIVE=false ARG CONFIG_NATIVE=false
ARG VARIANT=light ARG VARIANT=default
RUN apk --no-cache add build-base git gnupg && cd /tmp \ RUN apk --no-cache add build-base git gnupg && cd /tmp \
&& wget -q https://github.com/thestinger.gpg && gpg --import thestinger.gpg \ && wget -q https://github.com/thestinger.gpg && gpg --import thestinger.gpg \
@ -21,8 +19,7 @@ RUN apk --no-cache add build-base git gnupg && cd /tmp \
### Build Synapse ### Build Synapse
ARG ALPINE_VERSION FROM python:alpine as builder
FROM python:${PYTHON_VERSION}-alpine${ALPINE_VERSION} as builder
ARG SYNAPSE_VERSION ARG SYNAPSE_VERSION
@ -44,10 +41,8 @@ RUN apk -U upgrade \
### Build Production ### Build Production
ARG ALPINE_VERSION
ARG PYTHON_VERSION
FROM python:${PYTHON_VERSION}-alpine${ALPINE_VERSION} FROM python:alpine
ARG UID ARG UID
ARG GID ARG GID
@ -64,17 +59,20 @@ RUN apk -U upgrade \
zlib \ zlib \
tzdata \ tzdata \
xmlsec \ xmlsec \
git \
curl \ curl \
icu-libs \ icu-libs \
&& adduser -g ${GID} -u ${UID} --disabled-password --gecos "" synapse \ && adduser -g ${GID} -u ${UID} --disabled-password --gecos "" synapse \
&& rm -rf /var/cache/apk/* && rm -rf /var/cache/apk/*
RUN pip install --upgrade pip \
&& pip install -e "git+https://github.com/matrix-org/mjolnir.git#egg=mjolnir&subdirectory=synapse_antispam"
COPY --from=build-malloc /tmp/hardened_malloc/out-light/libhardened_malloc-light.so /usr/local/lib/ COPY --from=build-malloc /tmp/hardened_malloc/out/libhardened_malloc.so /usr/local/lib/
COPY --from=builder /install /usr/local COPY --from=builder /install /usr/local
COPY --chown=synapse:synapse rootfs / COPY --chown=synapse:synapse rootfs /
ENV LD_PRELOAD="/usr/local/lib/libhardened_malloc-light.so" ENV LD_PRELOAD="/usr/local/lib/libhardened_malloc.so"
USER synapse USER synapse

View File

@ -1,6 +1,6 @@
MIT License MIT License
Copyright (c) 2021 Wonderfall Copyright (c) 2021 Wonderfall, Thien Tran
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@ -1,17 +1,19 @@
# wonderfall/synapse # tommytran732/synapse
![Build, scan & push](https://github.com/wonderfall/docker-synapse/actions/workflows/build.yml/badge.svg) ![Build, scan & push](https://github.com/tommytran732/Synapse-Docker/actions/workflows/build.yml/badge.svg)
[Synapse](https://github.com/matrix-org/synapse) is a [Matrix](https://matrix.org/) implementation written in Python. [Synapse](https://github.com/matrix-org/synapse) is a [Matrix](https://matrix.org/) implementation written in Python.
### Notes ### Notes
- Prebuilt images are available at `ghcr.io/wonderfall/synapse`. - Prebuilt images are available at `ghcr.io/tommytran732/synapse` and `quay.io/tommytran732/synapse`.
- Don't trust random images: build yourself if you can. - Don't trust random images: build yourself if you can.
- Always keep your software up-to-date: manage versions with [build-time variables](https://github.com/Wonderfall/docker-synapse/blob/main/Dockerfile#L1-L6). - Always keep your software up-to-date: manage versions with [build-time variables](https://github.com/TommyTran732/Synapse-Docker/blob/main/Dockerfile#L1-L4).
- Images from `ghcr.io` are built every week, and scanned every day for critical vulnerabilities. - Images from `ghcr.io` are built every week and scanned every day for critical vulnerabilities with Trivy. I recommend that you use these images.
- Images from `quay.io` are built on every push event and scanned for vulnerabilities with Clair.
### Features & usage ### Features & usage
- Drop-in replacement for the [official image](https://github.com/matrix-org/synapse/tree/develop/docker). - Drop-in replacement for the [official image](https://github.com/matrix-org/synapse/tree/develop/docker).
- Unprivileged image: you should check your volumes permissions (eg `/data`), default UID/GID is 991. - Unprivileged image: you should check your volumes permissions (eg `/data`), default UID/GID is 991.
- Based on [Alpine](https://alpinelinux.org/), which provides more recent packages while having less attack surface. - Based on [Alpine](https://alpinelinux.org/), which provides more recent packages while having less attack surface.
- Comes with a [hardened memory allocator](https://github.com/GrapheneOS/hardened_malloc), protecting against some heap-based buffer overflows. - Comes with a [hardened memory allocator](https://github.com/GrapheneOS/hardened_malloc), protecting against some heap-based buffer overflows.
- [Mjolnir module](https://github.com/matrix-org/mjolnir/blob/main/docs/synapse_module.md) support.