README

Provides dev-null.sh integration for Symfony Notifier.

dev-null.sh is a social network for developers where you publish commits from your terminal. There is no login: a commit is signed locally with an SSH key that is on your GitHub account, and dev-null.sh checks the signature against the public keys GitHub publishes for you. This bridge does the same from a Symfony application.

DSN example

DEVNULL_DSN=devnull://default?private_key=%2Fhome%2Fme%2F.ssh%2Fid_ed25519

The private_key option is optional. When it is missing, the default SSH key of the user running the application is used: ~/.ssh/id_ed25519 first, then ~/.ssh/id_rsa.

DEVNULL_DSN=devnull://default

DSN options

Option	Required	Description
`private_key`	no	Path to the OpenSSH private key used to sign the commit. Defaults to the key of the user.
`passphrase`	no	Passphrase of the private key, if it is encrypted.
`namespace`	no	Signature namespace. Defaults to `devnull-commit`, the value dev-null.sh expects.
`ssl`	no	Set to `0` to use `http` instead of `https`, for a self-hosted instance. Defaults to `1`.

The host is default for dev-null.sh, or the domain of a self-hosted instance.

Usage

# config/packages/notifier.yaml
framework:
    notifier:
        chatter_transports:
            devnull: '%env(DEVNULL_DSN)%'

use Symfony\Component\Notifier\Message\ChatMessage;
use Symfony\Component\Notifier\ChatterInterface;

public function notify(ChatterInterface $chatter): void
{
    $chatter->send(new ChatMessage('Shipped the dev-null.sh notifier bridge!'));
}

To reply to an existing commit, pass its hash or link:

use GromNaN\Notifier\Bridge\DevNull\DevNullOptions;
use Symfony\Component\Notifier\Message\ChatMessage;

$options = (new DevNullOptions())->replyTo('0be0130');

$chatter->send(new ChatMessage('Agreed!', $options));

Standalone usage

The bridge also works without a Symfony application, by passing the transport factory to the Transport class of the Notifier. A runnable example is provided in examples/standalone.php:

use GromNaN\Notifier\Bridge\DevNull\DevNullTransportFactory;
use Symfony\Component\Notifier\Chatter;
use Symfony\Component\Notifier\Message\ChatMessage;
use Symfony\Component\Notifier\Transport;

require __DIR__.'/vendor/autoload.php';

// The Transport class only knows the bridges shipped with symfony/notifier, so it is built
// with an explicit factory list. Adding DevNullTransportFactory teaches it "devnull://".
$transportFactory = new Transport([
    new DevNullTransportFactory(),
]);

$transport = $transportFactory->fromString('devnull://default?private_key=%2Fhome%2Fme%2F.ssh%2Fid_ed25519');

$chatter = new Chatter($transport);

$sentMessage = $chatter->send(new ChatMessage('Shipped the dev-null.sh notifier bridge!'));

echo $sentMessage->getMessageId();

How it works

A commit body must be between 3 and 280 characters. The transport builds the payload <timestamp>\n<nonce>\n<reply to>\n<body>, signs it with the private key in the SSHSIG format (ssh-keygen -Y sign equivalent, implemented with phpseclib), and posts it to /api/cli/commits with the signature in the X-SSH-Signature header. The private key never leaves the machine, and only the signature is sent.

The signing is byte-for-byte identical to ssh-keygen -Y sign, so a commit made through this bridge is indistinguishable from one made with the devnull commit script.

Requirements

The private key must be one of the keys on the GitHub account of the dev-null.sh user you commit as. Ed25519 and RSA keys are supported.

The key is read from the filesystem. A key that only lives in an ssh-agent cannot be used, because the signature is computed in PHP and the agent never hands out the private key.

Installation

composer require gromnan/devnull-notifier

return [
    // ...
    GromNaN\Notifier\Bridge\DevNull\DevNullNotifierBundle::class => ['all' => true],
];

The bundle registers the transport factory with the Notifier. Without the bundle, register the factory manually as a service tagged chatter.transport_factory.

Sponsor

This package is not affiliated with dev-null.sh. The dev-null.sh service is built and maintained by Nuno Maduro.

gromnan / devnull-notifier

Package info

Security

Statistics