greetd-ipc(7)

greetd-ipc - IPC protocol for greetd

Section 7 greetd bookworm source

Description

greetd-ipc

NAME

greetd-ipc - IPC protocol for greetd

DESCRIPTION

This details the interprocess communication (IPC) protocol for greetd(1). This IPC protocol can be used to create and manage sessions under greetd.

The IPC protocol uses a UNIX socket as a method of communication. The path to the socket is stored in the environment variable GREETD_SOCK.

MESSAGE AND REPLY FORMAT

The format for messages and replies is:

<payload-length> <payload>

Where

<payload-length> is a 32-bit integer in native byte order
<payload> is a UTF-8-encoded JSON string.

For example, sending the "create_session" command would look like the following hexdump:

00000000 2c 00 00 00 7b 22 74 79 70 65 22 3a 20 22 63 72 |,...{"type": "cr|
00000010 65 61 74 65 5f 73 65 73 73 69 6f 6e 22 2c 20 22 |eate_session", "|
00000020 75 73 65 72 6e 61 6d 65 22 3a 20 22 6d 65 22 7d |username": "me"}|

MESSAGES

Requests

Image grohtml-82257-1.png

Responses

Image grohtml-82257-2.png

Authentication message type enums

Image grohtml-82257-3.png

Error enums

Image grohtml-82257-4.png

AUTHORS

Maintained by Kenny Levinsen <contact@kl.wtf>. For more information about greetd development, see https://git.sr.ht/˜kennylevinsen/greetd.

SEE ALSO

greetd(1)