Configuration Builder

Heimdall Configuration function builder is used to build a set of configuration that needed by the Authorization or Resource Server.

withAuthorizationConfig()

This method is used to build a HeimdallAuthorizationConfig instance for HeimdallAuthorizationServer.

Heimdall::withAuthorizationConfig(
  new ClientRepository(), // ClientRepository instance
  new AccessTokenRepository(), // AccessTokenRepository instance
  new ScopeRepository(), // ScopeRepository instance
  __DIR__ . "/private.key" // private.key file path
);

Using private.key password

If you generated private.key with a password, you NEED to add your password as an array like below:

Heimdall::withAuthorizationConfig(
  ...[
    "path" => __DIR__ . "/private.key",
    "password" => "your private.key password",
  ]
);

Strict private.key permission check

Optionally, you can add the permissionCheck index to the array and set the value as true to verify the permission of your private.key. The default value is false.

Heimdall::withAuthorizationConfig(
    ...
    [
        ...
        'permissionCheck' => true   // optional, to verify the permission of private.key
    ]
);

withResourceConfig()

This method is used to build a HeimdallResourceConfig instance for HeimdallResourceServer.

Heimdall::withResourceConfig(
    new AccessTokenRepository()     // AccessTokenRepository instance,
    __DIR__ . '/public.key'         // public.key file path
);

Using public.key password

If you generated public.key with a password, you NEED to add your password as an array like below:

Heimdall::withResourceConfig(
  ...[
    "path" => __DIR__ . "/public.key",
    "password" => "your public.key password",
  ]
);

Strict public.key permission check

Optionally, you can add the permissionCheck index to the array and set the value as true to verify the permission of your public.key. The default value is false.

Heimdall::withResourceConfig(
    ...
    [
        ...
        'permissionCheck' => true   // optional, to verify the permission of public.key
    ]
);