Credentials

MMO\admin\helpers · 1 symbol · generated 5 Oct 2026

class

Credentials

The secrets a deployment needs, read from a file in the project that git never sees.

class MMO\admin\helpers\Credentials

Namespace: MMO\admin\helpers

This exists because of a specific, real failure: the previous pipeline kept the production ssh password in `scripts/bootstrap.php`, a tracked file, which put it on 31 branches and in the history of every clone ever made. `.gitignore` discipline alone would not have stopped it -- it is a convention, and conventions get skipped -- so the rule here is structural rather than procedural: this file is REFUSED if git would commit it ([`assertIgnored`](https://mcp.mmoframework.fr/documentation/mmo.admin/php/helpers/Credentials.md#credentials-assertignored)). [`Server`](https://mcp.mmoframework.fr/documentation/mmo.admin/php/entities/Server.md#server) declares only an auth *method*; the value behind it is resolved, at use time, from here. The file is per-project and per-machine, at [`FILENAME`](https://mcp.mmoframework.fr/documentation/mmo.admin/php/helpers/Credentials.md#credentials-filename) beside `deploy.json`: ```json {"servers": { "ovh1": {"password": "..."}, "ovh2": {"privateKey": "~/.ssh/id_ed25519", "publicKey": "~/.ssh/id_ed25519.pub", "passphrase": "..."} }} ``` Nobody else may read it (mode 0600), and git must ignore it. Either one failing is refused outright rather than warned about, because a warning on a fleet tool is a warning nobody reads.

$credentials = new Credentials(Credentials::DefaultFilename('/var/www/my.oviepro')); $credentials->get('ovh1', 'password');

Index

	FILENAME	where a project keeps its deployment secrets: at its root, beside `deploy.json`.
	data
	filename
	loaded
	assertIgnored($filename)	Refuse a credentials file git would commit.
	assertPrivate($filename)	Refuse a credentials file anyone else on the machine can read.
	debugName()
	DefaultFilename($root) static	Where a project's credentials live by default: `FILENAME`, in the project.
	FromArray($servers) static
	get($server, $key, $required)
	getFilename()
	has($server, $key)
	isLoaded()
	servers()
	__construct($filename)

Constants1

FILENAME

where a project keeps its deployment secrets: at its root, beside deploy.json. init's .gitignore ignores it.

const FILENAME = 'deploy.credentials.json'

Properties3

data

protected array $data = []

Type: array

filename

protected ?string $filename = null

Type: null | string

loaded

protected bool $loaded = false

Type: bool

Methods11

assertIgnored($filename)

Credentials.php:164

Refuse a credentials file git would commit.

protected function assertIgnored(string $filename): void

The file lives in the project, so all that stands between it and the history of every clone is an ignore rule -- and an ignore rule is exactly what is missing the day it matters: a `.gitignore` older than the file, a pattern someone tidied away, a `git add -f`. So git is asked, every time the file is read. A TRACKED file is refused even when a rule matches it, since ignoring never untracks anything, and with a different remedy: what it holds may already be in a commit, and only changing the secrets undoes that. Outside a repository, or on a machine without git, there is nothing to commit it to.

$filename	string
returns	void
throws

assertPrivate($filename)

Credentials.php:134

Refuse a credentials file anyone else on the machine can read.

protected function assertPrivate(string $filename): void

$filename	string
returns	void
throws

debugName()

Credentials.php:70

function debugName(): string

returns

string

DefaultFilename($root)

staticCredentials.php:87

Where a project's credentials live by default: FILENAME, in the project.

static function DefaultFilename(string $root): string

$root	string	the project's folder -- the one holding `deploy.json`.
returns	string

FromArray($servers)

staticCredentials.php:76

static function FromArray(array $servers): static

$servers	array	server name => [key => value]: what `setup` is about to write, before it is written.
returns	static	credentials read from nowhere: nothing to check, as nothing is in a file.

get($server, $key, $required)

Credentials.php:112

function get(string $server, string $key, bool $required = false): ?string

$server	string
$key	string	`password`, `privateKey`, `publicKey`, `passphrase`.
$required = false	bool
returns	null \| string
throws		when $required and there is nothing to return.

getFilename()

Credentials.php:92

function getFilename(): ?string

returns null | string the file this reads, whether or not it exists (isLoaded).

has($server, $key)

Credentials.php:100

function has(string $server, ?string $key = null): bool

$server	string
$key = null	null \| string
returns	bool

isLoaded()

Credentials.php:95

function isLoaded(): bool

returns

bool

whether a credentials file was actually loaded.

servers()

Credentials.php:98

function servers(): array

returns

array

the servers this file carries secrets for.

__construct($filename)

Credentials.php:50

function __construct(?string $filename = null)

$filename = null	null \| string	resolved through `filename`. A missing file is NOT an error: a project whose servers all authenticate through the ssh agent needs no credentials file at all.
throws		if the file exists but git would commit it, someone else can read it, or it is not JSON.