QCloud COS FederationToken generator for Laravel.

安正超

Last update: Sep 26, 2022

Related tags

Authentication and Authorization laravel-qcloud-federation-token

Overview

Laravel 腾讯云联合身份临时访问凭证生成器

Laravel 腾讯云联合身份临时访问凭证生成器，主要用于下发腾讯云联合身份临时访问凭证，比如前端直传等场景。

开始之前，请您仔细阅读并理解一下官方文档：

安装

$ composer require overtrue/laravel-qcloud-federation-token -vvv

配置

你可以通过以下命令将配置文件写入 config/federation-token.php:

$ php artisan vendor:publish --provider="Overtrue\\LaravelQCloudFederationToken\\QCloudFederationTokenServiceProvider"

config/federation-token.php

return [
    // 默认配置，strategies 下的每一个策略将合并此基础配置
    'default' => [
        'secret_id' => env('QCLOUD_COS_SECRET_ID', ''),
        'secret_key' => env('QCLOUD_COS_SECRET_KEY', ''),
        'region' => env('QCLOUD_COS_REGION', 'ap-guangzhou'),
        "effect" => "allow",
        
        // 全局变量，会被替换到所有策略中
        'variables' => [
            'uid' => env('QCLOUD_COS_APP_ID'),
            'region' => env('QCLOUD_COS_REGION', 'ap-guangzhou'),
            //...
        ],
    ],
    // strategies
    'strategies' => [
        'cos' => [
            // 策略名称，可选
            'name' => 'cos-put',
            
            // 临时凭证过期时间
            'expires_in' => 1800,
            
            // 将与默认配置合并
            'variables' => [
                'appid' => env('QCLOUD_COS_APP_ID'),
                'bucket' => env('QCLOUD_COS_BUCKET', ''),
                //...
            ],
            
            // Statement 请参考：https://cloud.tencent.com/document/product/598/10603
            "statements" => [
                [
                    "action" => [
                        "cos:PutObject",
                        "cos:GetObject",
                    ],
                    "resource" => [
                        "qcs::cos:ap-beijing:uid/<appid>:<bucket>-<appid>/<date>/<uuid>/*",
                    ],
                ]
            ],
        ],
    ],
];

配置语法请参考：https://cloud.tencent.com/document/product/598/10603

你可以根据使用场景配置多个策略，然后按策略分发访问凭证。

Warning

注意：condition 中使用 cos:content-type 记得 urlencode, 不然遇到带+号的 MIME 将会失效，比如 image/svg+xml。

安全提醒

临时 token 规则配置不合理，可能会造成安全问题，请谨慎配置，请严格检查如下：

配置前请仔细阅读：《用于前端直传 COS 的临时密钥安全指引》
凭证生命周期不要设置过长。
避免使用主账号来生成凭证，专用的限制登录的 API 子账号。
按照《条件键说明及使用示例》添加请求限制如上传大小和类型等。
将账号权限控制在尽量小的范围内，避免越权操作。

变量替换

在配置中难免会用到各种上下文变量或者一些动态 resouce 路径等，你可以在配置中指定 variables 变量来实现变量替换，例如：

仅 principal 和 resource 中的变量可以替换，其他变量不支持替换。

// config/federation-token.php
<?php

return [
    // 默认配置，strategies 下的每一个策略将合并此基础配置
    'default' => [
        'secret_id' => env('QCLOUD_COS_SECRET_ID'),
        'secret_key' => env('QCLOUD_COS_SECRET_KEY'),
        'region' => env('QCLOUD_COS_REGION', 'ap-guangzhou'),
        "effect" => "allow",
        
        // 全局变量，会被替换到所有策略中
        'variables' => [
            'region' => env('QCLOUD_COS_REGION', 'ap-guangzhou'),
            //...
        ],
    ],
    // strategies
    'strategies' => [
        // 请参考：https://cloud.tencent.com/document/product/598/10603
        'cos' => [
            // 将与默认配置合并
            'variables' => [
                'appid' => env('QCLOUD_COS_APP_ID'),
                'bucket' => env('QCLOUD_COS_BUCKET'),
                //...
            ],
            "statements" => [
                [
                    "action" => [
                        "cos:PutObject",
                        "cos:GetObject",
                    ],
                    "resource" => [
                        "qcs::cos:ap-beijing:uid/<appid>:<bucket>-<appid>/<date>/<uuid>/*",
                    ],
                ]
            ],
        ],
    ],
];

以上配置将会生成如下结果：

{
    "effect": "allow",
    "action": [
        "cos:PutObject",
        "cos:GetObject",
    ],
    "resource": [
        "qcs::cos:ap-beijing:uid/12278900:example-12278900/20220202/bbeae9bb-d650-46f9-aab3-f4171a1bfdea/*"
    ]
}

内置变量如下

<uuid> - UUID 例如：ca007813-4a49-4d5a-afab-abae18a969a5
<timestamp> - 当前时间戳，例如：1654485526
<random> - 随机字符串，16 位，例如：Bbq6gkXXIPyCDsEL
<random:32> - 随机字符串，32 位，例如：FykbMqi6GT6JHiyv6E2xqUeo3CZLPjo7
<date> - 日期，例如：20220606
<Ymd> - 日期，例如：20220606
<YmdHis> - 日期时间（年月日时分秒），例如：20220606031846
<Y> - 年，例如：2022
<m> - 月，例如：06
<d> - 日，例如：06
<H> - 时，例如：03
<i> - 分，例如：18
<s> - 秒，例如：46

使用

use Overtrue\LaravelQCloudFederationToken\FederationToken;

// 使用默认策略（配置项 strategies 中第一个）
$token = FederationToken::createToken();

// 或者指定策略
$token = FederationToken::strategy('cos')->createToken();

$token->toArray();

// 'credentials' => [
//     'token' => 'kTRtHpOSOCUzTVWmzlPKweHffXjT9Izo7b61a142d6b56d31c0a7ace4d22bcff3zpbsXKTIrCo43dRRh7bDIKE1ZOE1KRYHEm0KNLjWG_aSF63YoQWchg',
//     'tmp_secret_id' => 'AKIDw7dwZbmFSup9CnAOraJ7skiPMybaV3WPP5B4oVMCIL5kLyphV_3IyAHFJ5QMCjE6',
//     'tmp_secret_key' => '/lvEo280/AlGt4orjDl9tWLIOMl5nkexS5Pg+xys7ps=',
// ],
// 'expired_at' => 1547696355,

格式请参考： https://cloud.tencent.com/document/product/1312/48195

事件

Event	Description
`Overtrue\LaravelQcloudFederationToken\Events\TokenCreated`	token 生成时触发

❤️ 赞助我

如果你喜欢我的项目并想支持它，点击这里 ❤️

贡献代码

你可以通过以下方式参与贡献:

通过 issue tracker 提交 Bug；
通过 issue tracker 回答问题或修复 Bug；
通过 Pull Request 增加新特性或优化文档。

代码贡献过程不需要很正式。你只需要确保你遵循 PSR-0、PSR-1 和 PSR-2 的编码准则。任何新的代码贡献都必须附带对应的单元测试。

Project supported by JetBrains

Many thanks to Jetbrains for kindly providing a license for me to work on this and other open-source projects.

PHP 扩展包开发

想知道如何从零开始构建 PHP 扩展包？

请关注我的实战课程，我会在此课程中分享一些扩展开发经验 —— 《PHP 扩展包实战教程 - 从入门到发布》

License

MIT

PHP package built for Laravel 5.* to easily handle a user email verification and validate the email

jrean/laravel-user-verification is a PHP package built for Laravel 5.* & 6.* & 7.* & 8.* to easily handle a user verification and validate the e-mail.

802 Dec 29, 2022

LDAP Authentication & Management for Laravel

👋 Hey there! Looking for something even easier to use for LDAP integration in your Laravel applications? 🎉 Introducing LdapRecord 🎉 LdapRecord is t

894 Dec 28, 2022

Limit access to your Laravel applications by using invite codes

Doorman Doorman provides a way to limit access to your Laravel applications by using invite codes. Invite Codes: Can be tied to a specific email addre

964 Dec 31, 2022

Declarative style of authorization and validation in laravel.

Laravel Hey Man Readability Counts. In fact, Readability is the primary value of your code !!! 🎀 Heyman continues where the other role-permission pac

860 Jan 1, 2023

Set up Laravel Auth guards using Eloquent in seconds

Nightguard Set up Auth guards using Eloquent in seconds. Introduction Laravel guards provide a super convenient way of authorizing different areas of

10 Mar 18, 2021

Paquete laravel para leer indicadores previsionales desde Previred y tramos de impuesto de 2da categoría desde SII

Laravel PreviScraper Indicadores previsionales Chile 🇨🇱 Indicadores previsionales desde Previred y tramos de impuesto desde SII Los datos se obtiene

11 Feb 9, 2022

Laravel starter kit with Livewire & Bootstrap 5 auth scaffolding.

Laravel Livewire Auth Laravel starter kit with Livewire & Bootstrap 5 auth scaffolding. Requirements NPM Installation Create a new Laravel app: larave

8 Sep 11, 2021

Minimalistic token-based authorization for Laravel API endpoints.

Bearer Minimalistic token-based authorization for Laravel API endpoints. Installation You can install the package via Composer: composer require ryang

74 Jun 17, 2022

Library to manage HTTP authentication with PHP. Includes ServiceProviders for easy Laravel integration.

Intervention HttpAuth Library to manage HTTP authentication with PHP. Includes ServiceProviders for easy Laravel integration. Installation You can ins

69 Jul 14, 2022

Releases(2.1.5)

2.1.5(Jul 8, 2022)
What's Changed

Update composer.json by @ranpro in https://github.com/overtrue/laravel-qcloud-federation-token/pull/1

New Contributors

@ranpro made their first contribution in https://github.com/overtrue/laravel-qcloud-federation-token/pull/1

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/2.1.4...2.1.5
Source code(tar.gz)
Source code(zip)
2.1.4(Jun 16, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/2.1.3...2.1.4
Source code(tar.gz)
Source code(zip)
2.1.3(Jun 8, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/2.1.1...2.1.3
Source code(tar.gz)
Source code(zip)
2.1.2(Jun 8, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/2.1.0...2.1.2
Source code(tar.gz)
Source code(zip)
2.1.1(Jun 8, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/2.1.0...2.1.1
Source code(tar.gz)
Source code(zip)
2.1.0(Jun 8, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/2.0.0...2.1.0
Source code(tar.gz)
Source code(zip)
2.0.0(Jun 8, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/1.1.3...2.0.0
Source code(tar.gz)
Source code(zip)
1.1.3(Jun 6, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/1.1.2...1.1.3
Source code(tar.gz)
Source code(zip)
1.1.2(Jun 6, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/1.1.1...1.1.2
Source code(tar.gz)
Source code(zip)
1.1.1(Jun 6, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/1.1.0...1.1.1
Source code(tar.gz)
Source code(zip)
1.1.0(Jun 6, 2022)
增加变量替换

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/compare/1.0.0...1.1.0
Source code(tar.gz)
Source code(zip)
1.0.0(May 30, 2022)

Full Changelog: https://github.com/overtrue/laravel-qcloud-federation-token/commits/1.0.0
Source code(tar.gz)
Source code(zip)

QCloud COS FederationToken generator for Laravel.

Related tags

Overview

Laravel 腾讯云联合身份临时访问凭证生成器

安装

配置

安全提醒

变量替换

内置变量如下

使用

事件

❤️ 赞助我

贡献代码

Project supported by JetBrains

PHP 扩展包开发

License

You might also like...

PHP package built for Laravel 5.* to easily handle a user email verification and validate the email

LDAP Authentication & Management for Laravel

Limit access to your Laravel applications by using invite codes

Declarative style of authorization and validation in laravel.

Set up Laravel Auth guards using Eloquent in seconds

Paquete laravel para leer indicadores previsionales desde Previred y tramos de impuesto de 2da categoría desde SII

Laravel starter kit with Livewire & Bootstrap 5 auth scaffolding.

Minimalistic token-based authorization for Laravel API endpoints.

Library to manage HTTP authentication with PHP. Includes ServiceProviders for easy Laravel integration.

Releases(2.1.5)

2.1.5(Jul 8, 2022)

What's Changed

New Contributors

2.1.4(Jun 16, 2022)

2.1.3(Jun 8, 2022)

2.1.2(Jun 8, 2022)

2.1.1(Jun 8, 2022)

2.1.0(Jun 8, 2022)

2.0.0(Jun 8, 2022)

1.1.3(Jun 6, 2022)

1.1.2(Jun 6, 2022)

1.1.1(Jun 6, 2022)

1.1.0(Jun 6, 2022)

1.0.0(May 30, 2022)

Owner

安正超

A Laravel 5 package for OAuth Social Login/Register implementation using Laravel socialite and (optionally) AdminLTE Laravel package

:octocat: Socialite is an OAuth2 Authentication tool. It is inspired by laravel/socialite, you can easily use it without Laravel.

An OAuth 2.0 bridge for Laravel and Lumen [DEPRECATED FOR LARAVEL 5.3+]

A Simple method to create laravel authentication for an existing laravel project.

Laravel Auth is a Complete Build of Laravel 8 with Email Registration Verification, Social Authentication, User Roles and Permissions, User Profiles, and Admin restricted user management system.

🔐 JSON Web Token Authentication for Laravel & Lumen

Handle roles and permissions in your Laravel application

Role-based Permissions for Laravel 5

Roles & Permissions for Laravel 8 / 7 / 6 / 5

Laravel wrapper around OAuth 1 & OAuth 2 libraries.