MMOFramework

function

actor

functions.php:44

Who opened the current session as user (« Changer de compte », sudo.switchAccount).

function actor(): ?MMO\oauth\interfaces\iUser

Namespace: MMO\oauth

This function MUST be called after middleware CurrentUser has been triggered.

returns

null | iUser

null when the session is the user's own.

if ($actor = \MMO\oauth\actor()) {echo "{$actor->getUsername()} works as " . \MMO\oauth\user()->getUsername();}

function

b64UrlDecode

functions.php:328

Decode a string with URL-safe Base64.

function b64UrlDecode(string $data): string|false

Namespace: MMO\oauth

$data	string	A Base64 encoded string
returns	string \| false	A decoded string

Call graph

Used by (5)

function

b64UrlEncode

functions.php:319

Encode a string with URL-safe Base64.

function b64UrlEncode(string $data): string

Namespace: MMO\oauth

$data	string	The string you want encoded
returns	string	The base64 encode of what you passed in

Call graph

Used by (5)

function

contentScopeID

functions.php:129

function contentScopeID(?MMO\client\entities\Content $value = null, string $action = ''): string

Namespace: MMO\oauth

$value = null	null \| Content
$action = ''	string
returns	string

Call graph

Used by (4)

function

decodeDER

functions.php:433

Reads binary DER-encoded data and decodes into a single object

function decodeDER(string $der): mixed

Namespace: MMO\oauth

$der	string	the binary data in DER format
returns	mixed	$data the decoded objects or null if nothing was found

Call graph

Uses (1)

decodeDER

Used by (4)

function

DERtoSignature

functions.php:504

Encodes signature from a DER object.

function DERtoSignature(string $der, int $keySize): string

Namespace: MMO\oauth

$der	string	binary signature in DER format
$keySize	int	the number of bits in the key
returns	string	the signature

Call graph

Uses (1)

decodeDER

function

encodeDER

functions.php:390

Encodes a value into a DER object.

function encodeDER(mixed $value, ?int $type = null): string

Namespace: MMO\oauth

$value	mixed	the value to encode
$type = null	null \| int	DER tag. if null, figure out the type from the value's type.
returns	string	the encoded object

Call graph

Uses (2)

Used by (5)

function

encodeDERLength

functions.php:377

DER-encode the length

function encodeDERLength(int $length): string

Namespace: MMO\oauth

DER supports lengths up to (2**8)**127, however, we'll only support lengths up to (2**8)**4. See {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.

$length	int
returns	string

Call graph

Used by (2)

function

entityScopeID

functions.php:105

function entityScopeID( MMO\core\interfaces\iRepository|MMO\core\interfaces\iCollection|MMO\core\interfaces\iEntity|null $value = null, string $action = '' ): string

Namespace: MMO\oauth

$value = null	iRepository \| iCollection \| iEntity \| null
$action = ''	string
returns	string

Call graph

Uses (1)

aModule::Shared

Used by (9)

function

generateKeys

functions.php:257

Generate a private/public key pair using openssl sha512

function generateKeys(?string $password = null, ?array $config = null): array

Namespace: MMO\oauth

$password = null	null \| string	an optionnal password to encrypt the private key
$config = null	null \| array	`openssl_pkey_new`
returns	array	PublicKey> the private and public key

function

getCSRFToken

functions.php:285

Create a CRSF token

function getCSRFToken(string $key, ?MMO\oauth\interfaces\iPrivateKey $privateKey = null): string

Namespace: MMO\oauth

$key	string	the session's key to save crsf token in
$privateKey = null	null \| iPrivateKey
returns	string	the csrf signature

Call graph

Uses (2)

Used by (1)

AccessController::renderNoToken

function

GUIDv4

functions.php:353

Generate valid version 4 UUIDS This function can serve to generate API keys

function GUIDv4(bool $trim = true): string

Namespace: MMO\oauth

$trim = true	bool
returns	string

function

isAllAllowed

functions.php:202

Test if all scopes are allowed Scopes expressed as string can be a list of scope's uid seperated by a space: each of them must be allowed too, as an OAuth2 scope parameter means.

function isAllAllowed(array $scopes, object|string ...$uids): bool

Namespace: MMO\oauth

NOTE: a space-separated list was, from March 2025, allowed as soon as ONE of its scopes was ('a b' with only 'a').

$scopes	array	array<uid: ?bool>
...$uids	object \| string	the scopes to test for
returns	bool

isAllAllowed(['a' => true], 'a b'); // false: 'b' is not allowed

Call graph

Uses (2)

Used by (12)

function

isAllowed

functions.php:154

Test if scope is allowed To compare two scopes, we look for any scopes containing the given one or one of its subset.

function isAllowed( array $scopes, string $uid, ?bool $default = false, ?string &$realUid = null ): ?bool

Namespace: MMO\oauth

$scopes	array	the current scopes
$uid	string	the scope's name
$default = false	null \| bool
$realUid = null	null \| string
returns	null \| bool

of resolving xxx.yyy.zzz#action look for a set scope in the following list (in this order): xxx.yyy.zzz#action > xxx.yyy.zzz > xxx.yyy#action > xxx.yyy > xxx#action > xxx

isAllowed(['pages.home.dashboard' => true], 'pages.home.dashboard'): true

isAllowed(['pages.home' => true], 'pages.home.dashboard'): true

isAllowed(['pages' => true], 'pages.home.dashboard'): true

isAllowed(['pages' => false], 'pages.home.dashboard'): false

isAllowed([], 'pages.home.dashboard'): false

isAllowed(['pages.dashboard#show' => true], 'pages.home.dashboard#show'): true

Call graph

Used by (22)

function

isAnyAllowed

functions.php:185

Test if at least one scope is allowed Scopes expressed as string can be a list of scope's uid seperated by a space (in this case, all scopes MUST be allowed).

function isAnyAllowed(array $scopes, object|string ...$uids): bool

Namespace: MMO\oauth

$scopes	array	array<uid: ?bool>
...$uids	object \| string	the scopes to test for
returns	bool	true when no scope is asked for

isAnyAllowed(['a' => true], 'a b', 'a'); // true: 'a b' is not ('b' is not allowed), 'a' is

Call graph

Uses (1)

isAllAllowed

Used by (9)

function

isUserAllowed

functions.php:53

function isUserAllowed(object|string ...$scopes): bool

Namespace: MMO\oauth

...$scopes	object \| string
returns	bool

Call graph

Uses (2)

Used by (1)

AccessController::onModeAccess

function

logout

functions.php:23

function logout(): void

Namespace: MMO\oauth

returns

void

Call graph

Uses (2)

Used by (1)

AccessController::logout

function

mergeScopes

functions.php:238

Merge scopes into source.

function mergeScopes(array &$source, array $scopes, bool $set = false): array

Namespace: MMO\oauth

Scopes are hierarchical. Sub scopes are separeted by dot. (ex: xxx.yyy.zzz) - if a scope has a value, all its sub-scopes iherits that value if they are not defined. - if a scope is not known, its value is null. - When resolving a scope, if its value is null (unknown), it becomes false. The rules to merge are as followed: |$source| null | true | false | $set |$scopes| | | | -------|-------|-------|-------|-------| false | true | true | true | false | | false | false | false | false | -------|-------|-------|-------|-------| true | true | true | true | true | | false | false | false | false | WARNING: merge(a,b,false) != merge(b,a,false) but merge(a,b,true) = merge(b,a,true)

$source	array	scopes to merge into
$scopes	array	list of {scope:uid} => {allow:bool}
$set = false	bool	`table` rule to merge
returns	array

Call graph

Uses (1)

isAllowed

Used by (15)

function

randomBytes

functions.php:343

Generate a unique identifier in hexadecimal

function randomBytes(?int $length = null, bool $raw = false): string

Namespace: MMO\oauth

$length = null	null \| int	the length in bytes. If null use the default length set in the package's config
$raw = false	bool	if true, don't encode in hexadecimal
returns	string	hexadecimal string

Call graph

Uses (1)

aModule::Shared

Used by (3)

function

scopeID

functions.php:91

Get the scope id for a given object

function scopeID(object $value, string $action = ''): string

Namespace: MMO\oauth

$value	object
$action = ''	string	- show: can be seen - edit: can be edited - create: can be created (if null before) - delete: can be removed - search: can be searched (even if not visible) - index: can be used in a calculus (even if not visible)
returns	string

Call graph

Uses (2)

Used by (10)

function

setUser

functions.php:49

function setUser(?MMO\oauth\interfaces\iClient $user): void

Namespace: MMO\oauth

$user	null \| iClient
returns	void

Call graph

Used by (8)

function

signatureToDER

functions.php:481

Convert an ECDSA signature to an ASN.1 DER sequence

function signatureToDER(string $sig): string

Namespace: MMO\oauth

$sig	string	The ECDSA signature to convert
returns	string	The encoded DER object

Call graph

Uses (1)

encodeDER

Used by (1)

JWT::Decode

function

user

functions.php:34

Get current user set in the route This function MUST be called after middleware CurrentUser has been triggered.

function user(): ?MMO\oauth\interfaces\iClient

Namespace: MMO\oauth

returns

null | iClient

Call graph

Used by (10)

function

usersAllowed

functions.php:65

The users whose rights allow $scope -- through their roles, their groups', their own scopes: who to notify of what only they can act on (a ticket to triage).

function usersAllowed(string $scope, int $limit = 500): array

Namespace: MMO\oauth

$scope	string
$limit = 500	int	at most this many
returns	array

\MMO\oauth\usersAllowed('dev.tickets#triage'); // the project leads

Call graph

Uses (1)

aModule::Shared

function

validateCSRFToken

functions.php:299

Validate a CRSF token

function validateCSRFToken( string $key, string $signature, ?MMO\oauth\interfaces\iPublicKey $publicKey = null, bool $clear = true ): bool

Namespace: MMO\oauth

$key	string	the session's key to save crsf token in
$signature	string	the csrf signature
$publicKey = null	null \| iPublicKey	a public key to verify the signature of the token
$clear = true	bool	if true, clear the crsf token from the session
returns	bool

Call graph

Uses (1)

b64UrlDecode

Used by (1)

AccessController::login