socialiteダウンロード - socialiteソースコードのダウンロード

社交家

Socialite は OAuth2 認証ツールです。これはlaravel/socialiteからインスピレーションを得ており、あらゆるPHPプロジェクトで簡単に使用できます。英語文書

スポンサーになってください

このツールは現在、次のプラットフォームをサポートしています: Facebook、Github、Google、Linkedin、Outlook、QQ、TAPD、Alipay、Taobao、Baidu、DingTalk、Weibo、WeChat、Douyin、Feishu、Lark、Douban、Enterprise WeChat、Tencent Cloud、Line、ジーティー、コーディング。

私のプロジェクトが気に入ってサポートしたい場合は、ここをクリックしてください❤️

バージョン要件

PHP >= 8.0.2

インストール

composer require " overtrue/socialite " -vvv

ユーザーガイド

ユーザーは、対応する構成変数を作成し、ツールを使用して各プラットフォームの認証アプリケーションを作成するだけで、プラットフォームの access_token とユーザー関連の情報を簡単に取得できます。ツールの実装ロジックの詳細については、各主要プラットフォームの OAuth2 ドキュメントを参照してください。

ツールの使用方法は大きく以下の手順に分かれます。

プラットフォーム設定を構成する
対応するプラットフォームアプリケーションを作成する
ユーザーがプラットフォーム認証にジャンプできるようにする
サーバーはプラットフォームコールバックコードを受信し、そのコードを使用してプラットフォーム上のユーザー情報 (access_token を含む) を交換します。

Laravel ユーザー向けに作成されたより便利な統合パッケージ: overtrue/laravel-socialite

authorize.php : ユーザーがプラットフォーム認証にジャンプできるようにします

 <?php

use Overtrue  Socialite  SocialiteManager ;

$ config = [
    ' github ' => [
        ' client_id '     => ' your-app-id ' ,
        ' client_secret ' => ' your-app-secret ' ,
        ' redirect '      => ' http://localhost/socialite/callback.php ' ,
    ],
];

$ socialite = new SocialiteManager ( $ config );

$ url = $ socialite -> create ( ' github ' )-> redirect ();

return redirect ( $ url );

callback.php :

 <?php

use Overtrue  Socialite  SocialiteManager ;

$ config = [
    ' github ' => [
        ' client_id ' => ' your-app-id ' ,
        ' client_secret ' => ' your-app-secret ' ,
        ' redirect ' => ' http://localhost/socialite/callback.php ' ,
    ],
];

$ socialite = new SocialiteManager ( $ config );

$ code = request ()-> query ( ' code ' );

$ user = $ socialite -> create ( ' github ' )-> userFromCode ( $ code );

$ user -> getId ();        // 1472352
$ user -> getNickname ();  // "overtrue"
$ user -> getUsername ();  // "overtrue"
$ user -> getName ();      // "安正超"
$ user -> getEmail ();     // "[email protected]"
. . .

構成

これは、各プラットフォームに同じキーと値のペアclient_id 、 client_secret 、 redirect ) を設定することですぐに機能します。

例：

 $ config = [
  ' weibo ' => [
    ' client_id '     => ' your-app-id ' ,
    ' client_secret ' => ' your-app-secret ' ,
    ' redirect '      => ' http://localhost/socialite/callback.php ' ,
  ],
  ' facebook ' => [
    ' client_id '     => ' your-app-id ' ,
    ' client_secret ' => ' your-app-secret ' ,
    ' redirect '      => ' http://localhost/socialite/callback.php ' ,
  ],
];

カスタムアプリケーション名

各プラットフォームには、 fooなどの任意の名前を付けることができます。エイリアスメソッドを使用した後、必要なプログラムを正しく見つける方法をツールキットに指示するために、構成に追加のproviderキーを設定する必要があります。

 $ config = [
  // 为 github 应用起别名为 foo
    ' foo ' => [
        ' provider '    => ' github ' ,  // <-- provider name
        ' client_id '   => ' your-app-id ' ,
        ' client_secret ' => ' your-app-secret ' ,
        ' redirect '    => ' http://localhost/socialite/callback.php ' ,
    ],

    // 另外一个名字叫做 bar 的 github 应用
    ' bar ' => [
        ' provider '    => ' github ' ,  // <-- provider name
        ' client_id '   => ' your-app-id ' ,
        ' client_secret ' => ' your-app-secret ' ,
        ' redirect '    => ' http://localhost/socialite/callback.php ' ,
    ],

    //...
];

$ socialite = new SocialiteManager ( $ config );

$ appFoo = $ socialite -> create ( ' foo ' );
$ appBar = $ socialite -> create ( ' bar ' );

カスタムサービスプロバイダーを拡張する

次の 2 つの点に従うことで、カスタムサービスプロバイダーからアプリケーションを簡単に作成できます。

カスタムクリエーターを使用する
次のコードに示すように、サービスプロバイダー名は foo アプリケーションに定義されていますが、ツール自体はまだそれをサポートしていないため、作成者のextend()使用してサービスプロバイダーのインスタンスをクロージャの形式で作成します。関数。

 $ config = [
    ' foo ' => [
        ' provider ' => ' myprovider ' ,  // <-- 一个工具还未支持的服务提供程序
        ' client_id ' => ' your-app-id ' ,
        ' client_secret ' => ' your-app-secret ' ,
        ' redirect ' => ' http://localhost/socialite/callback.php ' ,
    ],
];

$ socialite = new SocialiteManager ( $ config );

$ socialite -> extend ( ' myprovider ' , function ( array $ config ) {
    return new MyCustomProvider ( $ config );
});

$ app = $ socialite -> create ( ' foo ' );

サービスプロバイダークラスを使用する

重要

? カスタムサービスプロバイダークラスはOvertrueSocialiteContractsProviderInterfaceインターフェイスを実装する必要があります。

 class MyCustomProvider implements  Overtrue  Socialite  Contracts ProviderInterface
{
    //...
}

次に、ツールがクラスを見つけてインスタンス化できるように、 providerのクラス名を設定します。

 $ config = [
    ' foo ' => [
        ' provider '    => MyCustomProvider::class,  // <-- 类名
        ' client_id '   => ' your-app-id ' ,
        ' client_secret ' => ' your-app-secret ' ,
        ' redirect '    => ' http://localhost/socialite/callback.php ' ,
    ],
];

$ socialite = new SocialiteManager ( $ config );
$ app = $ socialite -> create ( ' foo ' );

プラットフォーム

プラットフォームごとに構成方法が異なります。ツールが正常に動作するようにするには、使用しているプラットフォームの構成が期待どおりに設定されていることを確認してください。

アリペイ

以下のように設定してください

 $ config = [
  ' alipay ' => [
    // 这个键名还能像官方文档那样叫做 'app_id'
    ' client_id ' => ' your-app-id ' ,

    // 请根据官方文档，在官方管理后台配置 RSA2
    // 注意： 这是你自己的私钥
    // 注意： 不允许私钥内容有其他字符
    // 建议： 为了保证安全，你可以将文本信息从磁盘文件中读取，而不是在这里明文
    ' rsa_private_key ' => ' your-rsa-private-key ' ,

    // 确保这里的值与你在服务后台绑定的地址值一致
    // 这个键名还能像官方文档那样叫做 'redirect_url'
    ' redirect ' => ' http://localhost/socialite/callback.php ' ,

    // 沙箱模式接入地址见 https://opendocs.alipay.com/open/220/105337#%E5%85%B3%E4%BA%8E%E6%B2%99%E7%AE%B1
    ' sandbox ' => false ,
  ]
  . . .
];

$ socialite = new SocialiteManager ( $ config );

$ user = $ socialite -> create ( ' alipay ' )-> userFromCode ( ' here is auth code ' );

// 详见文档后面 "User interface"
$ user -> getId ();        // 1472352
$ user -> getNickname ();  // "overtrue"
$ user -> getUsername ();  // "overtrue"
$ user -> getName ();      // "安正超"
. . .

このツールは現在、RSA2 個人秘密キー認証方式のみをサポートしています。

ディントーク

ドキュメントに示されているように、

注: このツールは、サードパーティの Web サイトに接続してユーザー情報 (opeid、unionid、ニックネーム) を取得するための QR コードのみをサポートします。

 $ config = [
  ' dingtalk ' => [
      // or 'app_id'
      ' client_id ' => ' your app id ' ,

      // or 'app_secret'
      ' client_secret ' => ' your app secret ' ,

      // or 'redirect_url'
      ' redirect ' => ' redirect URL '
  ]
];

$ socialite = new SocialiteManager ( $ config );

$ user = $ socialite -> create ( ' dingtalk ' )-> userFromCode ( ' here is auth code ' );

// 详见文档后面 "User interface"
$ user -> getId ();        // 1472352
$ user -> getNickname ();  // "overtrue"
$ user -> getUsername ();  // "overtrue"
$ user -> getName ();      // "安正超"
. . .

ティックトック

注: Douyin サービスを使用する際、access_token を直接使用してユーザー情報を取得したい場合は、最初に openid を設定してください。最初にwithOpenId()呼び出し、次にuserFromToken()呼び出します

 $ config = [
  ' douyin ' => [
      ' client_id ' => ' your app id ' ,

      ' client_secret ' => ' your app secret ' ,

      ' redirect ' => ' redirect URL '
  ]
];

$ socialite = new SocialiteManager ( $ config );

$ user = $ socialite -> create ( ' douyin ' )-> userFromCode ( ' here is auth code ' );

$ user = $ socialite -> create ( ' douyin ' )-> withOpenId ( ' openId ' )-> userFromToken ( ' here is the access token ' );

見出し

注:头条サービスを使用する際、access_token を直接使用してユーザー情報を取得したい場合は、最初に openid を設定してください。最初にwithOpenId()呼び出し、次にuserFromToken()呼び出します

 $ config = [
  ' toutiao ' => [
    ' client_id ' => ' your app id ' ,
    ' client_secret ' => ' your app secret ' ,
    ' redirect ' => ' redirect URL '
  ]
];

$ socialite = new SocialiteManager ( $ config );

$ user = $ socialite -> create ( ' toutiao ' )-> userFromCode ( ' here is auth code ' );
$ user = $ socialite -> create ( ' toutiao ' )-> withOpenId ( ' openId ' )-> userFromToken ( ' here is the access token ' );

スイカ

注:西瓜サービスを使用する際、access_token を直接使用してユーザー情報を取得したい場合は、最初に openid を設定してください。最初にwithOpenId()呼び出し、次にuserFromToken()呼び出します

 $ config = [
  ' xigua ' => [
    ' client_id ' => ' your app id ' ,
    ' client_secret ' => ' your app secret ' ,
    ' redirect ' => ' redirect URL '
  ]
];

$ socialite = new SocialiteManager ( $ config );

$ user = $ socialite -> create ( ' xigua ' )-> userFromCode ( ' here is auth code ' );
$ user = $ socialite -> create ( ' xigua ' )-> withOpenId ( ' openId ' )-> userFromToken ( ' here is the access token ' );

百度

他の構成では、使用方法に違いはありません。withDisplay withDisplay()を使用してログインページをリダイレクトするモードを簡単に選択できます。

**page:** 全画面認証ページ (デフォルト)、Web アプリケーションに適しています。
ポップアップ:ポップアップボックスの形式の認証ページ。デスクトップソフトウェアアプリケーションや Web アプリケーションに適しています。
ダイアログ:フローティングレイヤーの形式の認証ページ。サイト内の Web アプリケーションにのみ使用できます。
mobile: Iphone/Android などのスマートモバイル端末で使用される認証ページで、Iphone/Android などのスマートモバイル端末のアプリケーションに適しています。
tv:テレビなどの大型ディスプレイで使用するための認証ページ。
Pad： IPad/Androidなどのスマートタブレットの認証ページです。

 $ authUrl = $ socialite -> create ( ' baidu ' )-> withDisplay ( ' mobile ' )-> redirect ();

popupモードは、ツール内のデフォルトの使用モードです。 basic使用されるデフォルトのスコープ値です。

フェイシュ

いくつかの簡単な方法で app_ticket を構成することで、内部アプリケーションモードを使用できます。

 $ config = [
    ' feishu ' => [
        // or 'app_id'
        ' client_id ' => ' your app id ' ,

        // or 'app_secret'
        ' client_secret ' => ' your app secret ' ,

        // or 'redirect_url'
        ' redirect ' => ' redirect URL ' ,

        // 如果你想使用使用内部应用的方式获取 app_access_token
        // 对这个键设置了 'internal' 值那么你已经开启了内部应用模式
        ' app_mode ' => ' internal '
    ]
];

$ socialite = new SocialiteManager ( $ config );

$ feishuDriver = $ socialite -> create ( ' feishu ' );

$ feishuDriver -> withInternalAppMode ()-> userFromCode ( ' here is code ' );
$ feishuDriver -> withDefaultMode ()-> withAppTicket ( ' app_ticket ' )-> userFromCode ( ' here is code ' );

ヒバリ

いくつかの簡単な方法で app_ticket を構成することで、内部アプリケーションモードを使用できます。

 $ config = [
    ' lark ' => [
        // or 'app_id'
        ' client_id ' => ' your app id ' ,

        // or 'app_secret'
        ' client_secret ' => ' your app secret ' ,

        // or 'redirect_url'
        ' redirect ' => ' redirect URL ' ,

        // 如果你想使用使用内部应用的方式获取 app_access_token
        // 对这个键设置了 'internal' 值那么你已经开启了内部应用模式
        ' app_mode ' => ' internal '
    ]
];

$ socialite = new SocialiteManager ( $ config );

$ larkDriver = $ socialite -> create ( ' lark ' );

$ larkDriver -> withInternalAppMode ()-> userFromCode ( ' here is code ' );
$ larkDriver -> withDefaultMode ()-> withAppTicket ( ' app_ticket ' )-> userFromCode ( ' here is code ' );

タオバオ

その他の設定は他のプラットフォームと同じで、 withView()使用して表示するリダイレクトページのタイプを選択できます。

 $ authUrl = $ socialite -> create ( ' taobao ' )-> withView ( ' wap ' )-> redirect ();

webモードはツールで使用されるデフォルトの表示モードで、 user_infoデフォルトのスコープ値です。

微信

当社は、パブリックアカウントに代わってサードパーティプラットフォームの Web ページを承認するオープンプラットフォームをサポートしています。

以下のように設定を入力するだけです。公式アカウントは承認を必要としません。

 . . .
[
    ' wechat ' =>
        [
            ' client_id '   => ' client_id ' ,
            ' client_secret ' => ' client_secret ' ,
            ' redirect '    => ' redirect-url ' ,

            // 开放平台 - 第三方平台所需
            ' component ' => [
                // or 'app_id', 'component_app_id' as key
                ' id ' => ' component-app-id ' ,
                // or 'app_token', 'access_token', 'component_access_token' as key
                ' token ' => ' component-access-token ' ,
            ]
        ]
],
...

コーディング

さらに、 team_urlチームのドメイン名として構成する必要があります。たとえば、次のようになります。

 $ config = [
    ' coding ' => [
        ' team_url ' => ' https://{your-team}.coding.net ' ,
        ' client_id ' => ' your app id ' ,
        ' client_secret ' => ' your app secret ' ,
        ' redirect ' => ' redirect URL ' ,
    ]
];

ペイパル

場合によってはid_token responseType を設定する必要があります。withResponseType 関数を使用して設定できます。デフォルトはcodeであり、 withResponseTypeまたはcode & id_token

https://developer.paypal.com/docs/log-in-with-paypal/integrate/generate-button/

 $ config = [
    ' paypal ' => [
        ' client_id '     => ' AT****************** ' ,
        ' client_secret ' => ' EK************** ' ,
        ' sandbox '      => false ,
        ' redirect_url ' => " nativexo://paypalpay " ,
    ],
];

その他のヒント

スコープ

ユーザーをリダイレクトする前に、 scopes()メソッドを使用してリクエストに「スコープ」を設定することもできます。このメソッドは、既存のスコープをすべて上書きします。

 $ response = $ socialite -> create ( ' github ' )
                -> scopes ([ ' scope1 ' , ' scope2 ' ])-> redirect ();

リダイレクトURL

「 redirect_uri 」を動的に設定することもできます。次のメソッドを使用してredirect_uri URL を変更できます。

 $ url = ' your callback url. ' ;

$ socialite -> redirect ( $ url );
// or
$ socialite -> withRedirectUrl ( $ url )-> redirect ();

州

アプリケーションは、ステータスパラメーターを使用して、応答が要求を開始したのと同じユーザーに属することを確認することで、クロスサイトリクエストフォージェリ (CSFR) 攻撃を防ぐことができます。 CSFR 攻撃は、悪意のある攻撃者がユーザーをだまして、信頼された Web アプリケーション上でそのユーザーのみが実行できる許可を持っている望ましくないアクションを、ユーザーの関与や警告なしに実行させるときに発生します。

ここでは、状態を提供することでアプリケーションの安全性がどのように高まるかを示す最小限の例を示します。この例では、セッション ID を状態パラメータとして使用しますが、状態の値を作成するために任意のロジックを使用できます。

`state`パラメータを使用したリダイレクト

 <?php
session_start ();

$ config = [
    //...
];

// Assign to state the hashing of the session ID
$ state = hash ( ' sha256 ' , session_id ());

$ socialite = new SocialiteManager ( $ config );

$ url = $ socialite -> create ( ' github ' )-> withState ( $ state )-> redirect ();

return redirect ( $ url );

コールバックの`state`を確認する

ユーザーがアプリを承認すると、ユーザーはアプリの redirect_uri にリダイレクトされます。 OAuth サーバーはステータスパラメータを変更せずに返します。 redirect_uri で指定されたステータスがアプリケーションによって生成されたステータスと一致することを確認します。

 <?php
session_start ();

$ state = request ()-> query ( ' state ' );
$ code = request ()-> query ( ' code ' );

// Check the state received with current session id
if ( $ state != hash ( ' sha256 ' , session_id ())) {
    exit ( ' State does not match! ' );
}
$ user = $ socialite -> create ( ' github ' )-> userFromCode ( $ code );

// authorized

stateパラメータに関するドキュメントをさらに表示する

その他のパラメータ

リクエストにオプションのパラメータを含めるには、設定する値の連想配列を渡してwith()メソッドを呼び出します。

 $ response = $ socialite -> create ( ' google ' )
                    -> with ([ ' hd ' => ' example.com ' ])-> redirect ();

ユーザーインターフェース

標準ユーザーAPI

 $ user = $ socialite -> create ( ' github ' )-> userFromCode ( $ code );

{
  "id" : 1472352 ,
  "nickname" : " overtrue " ,
  "name" : "安正超" ,
  "email" : " [email protected] " ,
  "avatar" : " https://avatars.githubusercontent.com/u/1472352?v=3 " ,
  "raw" : {
    "login" : " overtrue " ,
    "id" : 1472352 ,
    "avatar_url" : " https://avatars.githubusercontent.com/u/1472352?v=3 " ,
    "gravatar_id" : " " ,
    "url" : " https://api.github.com/users/overtrue " ,
    "html_url" : " https://github.com/overtrue " ,
    ...
  },
  "token_response" : {
    "access_token" : " 5b1dc56d64fffbd052359f032716cc4e0a1cb9a0 " ,
    "token_type" : " bearer " ,
    "scope" : " user:email "
  }
}

次のように配列キーとしてユーザー属性を取得できます。

 $ user [ ' id ' ];        // 1472352
$ user [ ' nickname ' ];  // "overtrue"
$ user [ ' name ' ];      // "安正超"
$ user [ ' email ' ];     // "[email protected]"
. . .

または、 Userオブジェクトのメソッドを使用します。

mixed   $ user -> getId ();
?string $ user -> getNickname ();
?string $ user -> getName ();
?string $ user -> getEmail ();
?string $ user -> getAvatar ();
?string $ user -> getRaw ();
?string $ user -> getAccessToken ();
?string $ user -> getRefreshToken ();
?int    $ user -> getExpiresIn ();
?array  $ user -> getTokenResponse ();

OAuth API 応答から生データを取得する

$user->getRaw()メソッドは配列を返します。

userFromCode()を使用する場合、トークン応答の元のデータを取得したい

$user->getTokenResponse()メソッドは、トークンの取得時に API から返された応答を含む配列を返します。

注: このメソッドは、 userFromCode()使用する場合にのみ有効な配列を返します。それ以外の場合、 userFromToken()にはトークンの HTTP 応答がないため、 nullが返されます。

アクセストークンによるユーザー情報の取得

 $ accessToken = ' xxxxxxxxxxx ' ;
$ user = $ socialite -> userFromToken ( $ accessToken );

楽しんでください❤️

参照

Alipay - ユーザー情報の認証
DingTalk - QR コードをスキャンしてサードパーティの Web サイトにログインします
Google - OpenID Connect
Github - OAuth アプリの認証
Facebook - グラフ API
Linkedin - OAuth 2.0 による認証
Weibo - OAuth 2.0 認証メカニズムの説明
QQ - OAuth 2.0 QQ へのログイン
テンセントクラウド - OAuth2.0
WeChat パブリックプラットフォーム - OAuth ドキュメント
WeChat オープンプラットフォーム - ウェブサイトアプリケーション WeChat ログイン開発ガイド
WeChat オープンプラットフォーム - 公開アカウントに代わって Web ページの認証を開始します
エンタープライズ WeChat - OAuth ドキュメント
エンタープライズ WeChat サードパーティアプリケーション - OAuth ドキュメント
Douban-OAuth 2.0 認証メカニズムの説明
Douyin - Web サイトアプリケーション開発ガイド
フェイシュ認証手順書
Lark - ライセンスの説明
Tapd - ユーザー認証手順
ラインOAuth 2.0
Gitee - OAuth ドキュメント
PayPal - OAuth ドキュメント

PHP拡張パッケージの開発

PHP 拡張パッケージを最初から構築する方法を知りたいですか?
拡張機能開発の経験を共有する私の実践的なコース「PHP 拡張パック実践チュートリアル - 入門からリリースまで」に注目してください。

ライセンス

マサチューセッツ工科大学

拡大する

socialite

社交家