casdoor / casdoor-php-sdk Goto Github PK

View Code? Open in Web Editor NEW

18.0 5.0 10.0 54 KB

PHP client SDK for Casdoor

Home Page: https://github.com/casdoor/casdoor

License: Apache License 2.0

PHP 100.00%

php casdoor oauth saml auth authn authentication sso oidc

casdoor-php-sdk's Introduction

casdoor-php-sdk

Casdoor PHP SDK will allow you to easily connect your application to Casdoor authentication system without having to start from scratch.

Step 1: Composer install casdoor-php-sdk

In your php application directory, run the following command:

composer require casdoor/casdoor-php-sdk

Or use composer.json to add the following code:

{
    "require": {
        "vendor/package": "*",
    }
}

Then run composer install to make it take effect. Create a OauthTest. Php file and import the SDK package.

<?php

namespace Casdoor\Tests;

use PHPUnit\Framework\TestCase;
use Casdoor\Auth\Jwt;
use Casdoor\Auth\Token;
use Casdoor\Auth\User;

class OauthTest extends TestCase
{
  public function xxx(){}
}

Step 2: configure parameters

for more information, see initConfig()

Parameter	required	description
endpoint	Yes	The back-end API address of the Casdoor, for example:http://localhost:8000
clientId	Yes	The client ID of the current application.
clientSecret	Yes	The client key of the current application.
certificate	Yes	Public key certificate in x509 format under the certificate module (file format public_key.pem)
organizationName	Yes	The organization name of the current application configuration.
applicationName	Yes	The name of the current application.

Reference code:

public function initConfig()
  {
    $endpoint = 'http://127.0.0.1:8000';
    $clientId = 'c64b12723aefb65a88ce';
    $clientSecret = 'c0c9d483a87332751b2564635765d71c9f6a2e83';
    $certificate = file_get_contents(dirname(__FILE__) . '/public_key.pem');
    $organizationName = 'built-in';
    $applicationName = 'testApp';
    User::initConfig($endpoint, $clientId, $clientSecret, $certificate, $organizationName, $applicationName);
  }

Step 3: obtain the user JWT token

after you log on to the logon page, the page is redirected to a link with code and state, such:https://forum.casbin.com?code=xxx&state=yyyy In the sample file, enter code and state, call the testGetOauthToken() method, and parse the jwt token.

public $code = "cc78dc9953ca6ae6ab58";
public $state = "casdoor";
public function testGetOauthToken()
{
    $this->initConfig();
    $token = new Token();
    $accessToken = $token->getOAuthToken($this->code, $this->state);
    $this->assertIsString($accessToken->getToken());
}

The JWT token represents the user's identity and has the right to call relevant APIs.

Step 4: verify and parse the user token

When a user passes in a JWT token, testParseJwtToken function calls the public key to verify the JWT token. If the verification is passed, the Array object is returned, which contains the account information of the user.

public function testParseJwtToken()
{
    $this->initConfig();
    $token = "eyJhxxxx";	// from testGetOauthToken()
    $jwt = new Jwt();
    $result = $jwt->parseJwtToken($token, User::$authConfig);
    $this->assertIsArray();
}

Step 5: update user information

testModifyUser call the application configuration (non-user token) as the update permission to perform CURD operations on user information.

public function testModifyUser()
{
    $this->initConfig();
    $user = new User();

    # Delete User
    $user->name = 'user_hn99qa';
    $response = $user->deleteUser($user);
    $this->assertTrue($response);

    # Add User
    $response = $user->addUser($user);
    $this->assertTrue($response);

    # Update User
    $user->phone = 'phone';
    $user->displayName = 'display name';
    $response = $user->updateUser($user);
    $this->assertTrue($response);
}

Others: User interaction

User::getUser() , obtain User information by User name
User::getUsers() to obtain information about all users.
User::getUserCount() to obtain the current number of users.

casdoor-php-sdk's People

Contributors

Stargazers

Watchers

Forkers

basakest qeezer lyhiving linvery tx321-4 ducheng1977 netandreus i0gan jiawenzou dunhao

casdoor-php-sdk's Issues

Fix source code CI

Add badges to README

Like: https://github.com/php-casbin/php-casbin

feat: add test cases for all objects and all operations

Like:

Creation of dynamic property Casdoor\Auth\AuthConfig::$jwtPublicKey is deprecated

Hello, @hsluoyz !
Can you please accept my pull request with fix for this issue and publish 1.0.3 version of this library to packagist?

PHP-Casdoor-SDK can't create application

class OauthTest extends TestCase
{
private array $config;

private AuthConfig $auth;

#[PostMapping(path: '/api/system/backend/site/casdoor')]
public function __invoke(): void
{
    $this->config = [
        'endpoint' => 'http://localhost:9501',
        'clientId' => '',
        'clientSecret' => '',
        'jwtPublicKey' => '',
        'organizationName' => '',
        'applicationName' => '',
    ];
    $this->auth = new AuthConfig(...$this->config);
    $app = new Application('', '');
    $app->addApplication($app, $this->auth);
}

}

This is my code， and this is error message.

[CRITICAL] Error: Call to undefined function GuzzleHttp\Psr7\get_message_body_summary() in /opt/www/vendor/gb-hyperf/framework/src/Exception/Handler/GuzzleRequestExceptionHandler.php:38
Stack trace:
#0 /opt/www/vendor/hyperf/exception-handler/src/ExceptionHandlerDispatcher.php(43): Gb\Framework\Exception\Handler\GuzzleRequestExceptionHandler->handle()
casdoor/casdoor#1 /opt/www/vendor/hyperf/http-server/src/Server.php(87): Hyperf\ExceptionHandler\ExceptionHandlerDispatcher->dispatch()
casdoor/casdoor#2 /opt/www/vendor/hyperf/utils/src/SafeCaller.php(29): Hyperf\HttpServer\Server->Hyperf\HttpServer{closure}()
casdoor/casdoor#3 /opt/www/vendor/hyperf/http-server/src/Server.php(90): Hyperf\Utils\SafeCaller->call()
casdoor/casdoor#4 [internal function]: Hyperf\HttpServer\Server->onRequest()
casdoor/casdoor#5 {main}