构建OAuth应用

1 Github文档

您可以构建OAuth应用程序以供个人或公共使用。 了解如何为OAuth应用注册和设置权限和授权选项。

1.1 创建OAuth应用程序

您可以在个人帐户下或在您具有管理访问权限的任何组织下创建和注册OAuth应用程序。 在创建OAuth应用时,请记住仅使用您认为公开的信息来保护您的隐私。

1.2 为OAuth应用程序创建自定义徽章

您可以上传自己的徽标图片并自定义背景,从而替换OAuth应用中的默认徽章。

1.3 授权OAuth应用程序

您可以启用其他用户授权您的OAuth应用。

注意:GitHub的OAuth实现支持标准授权码模式。 您应该实现下面描述的Web应用程序流程以获取授权代码,然后将其交换为令牌。 (不支持简化模式)

1.3.1 Web应用程序流

授权用户使用您的应用的流程是:

  1. 用户被重定向以请求他们的GitHub身份
  2. 用户被GitHub重定向回您的网站
  3. 您的应用使用用户的访问令牌访问API

1.3.1.1 用户被重定向以请求他们的GitHub身份

GET https://github.com/login/oauth/authorize

Parameters:

  • client_id
  • redirect_uri
  • scope
  • state
  • allow_signup

1.3.1.2 用户被GitHub重定向回您的网站

如果用户接受您的请求,GitHub将使用代码参数中的临时代码以及您在上一步中在状态参数中提供的状态重定向回您的站点。 如果状态不匹配,则请求由第三方创建,并且应该中止该过程。

将此代码交换为访问令牌:

POST https://github.com/login/oauth/access_token
Parameters:
  • client_id
  • client_secret
  • code
  • redirect_uri
  • state
Response

默认情况下,响应采用以下形式:

access_token=e72e16c7e42f292c6912e7710c838347ae178b4a&token_type=bearer

您还可以根据Accept标头接收不同格式的内容:

Accept: application/json
{"access_token":"e72e16c7e42f292c6912e7710c838347ae178b4a", "scope":"repo,gist", "token_type":"bearer"}

Accept: application/xml
<OAuth>
  <token_type>bearer</token_type>
  <scope>repo,gist</scope>
  <access_token>e72e16c7e42f292c6912e7710c838347ae178b4a</access_token>
</OAuth>

1.3.1.3 您的应用使用用户的访问令牌访问API

访问令牌允许您代表用户向API发出请求。

GET https://api.github.com/user?access_token=...

您可以在查询参数中传递令牌,如上所示,但更简洁的方法是将其包含在Authorization标头中。

Authorization: token OAUTH-TOKEN

例如,在curl中,您可以像这样设置Authorization标头:

curl -H "Authorization: token OAUTH-TOKEN" https://api.github.com/user

1.3.2 重定向URLs

redirect_uri参数是可选的。 如果省略,GitHub会将用户重定向到OAuth应用程序设置中配置的回调URL。 如果提供,重定向URL的主机和端口必须与回调URL完全匹配。 重定向URL的路径必须引用回调URL的子目录。

CALLBACK: http://example.com/path

GOOD: http://example.com/path
GOOD: http://example.com/path/subdir/other
BAD:  http://example.com/bar
BAD:  http://example.com/
BAD:  http://example.com:8080/path
BAD:  http://oauth.example.com:8080/path
BAD:  http://example.org

1.3.3 为OAuth应用程序创建多个令牌

您可以为用户/应用程序/范围组合创建多个令牌,以便为特定用例创建令牌。

如果您的OAuth应用程序支持使用GitHub进行登录的一个工作流程并且仅需要基本用户信息,则此功能非常有用。 另一个工作流可能需要访问用户的私有存储库。 使用多个令牌,您的OAuth应用程序可以为每个用例执行Web流程,仅请求所需的范围。 如果用户仅使用您的应用程序登录,则他们永远不需要授予您对其私有存储库的OAuth应用程序访问权限。

每个用户/应用程序/范围组合发布的令牌数量有限制。 如果您的应用程序请求足够的令牌超过其中一个限制,则较旧的令牌将停止工作。

1.3.4 指导用户查看其访问权限

您可以链接到OAuth应用程序的授权信息,以便用户可以查看和撤消其应用程序授权。

要构建此链接,您需要在注册应用程序时从GitHub收到的OAuth Apps client_id。

https://github.com/settings/connections/applications/:client_id

1.4 了解OAuth应用程序的范围

通过范围,您可以准确指定所需的访问类型。 范围限制OAuth令牌的访问权限。 他们不会授予超出用户已有权限的任何其他权限。


2 gitlab文档

2.1 Web应用程序流

2.1.1 请求授权码

2.1.2 请求访问令牌

2.2 简化模式

与Web流不同,客户端会在授权请求后立即收到访问令牌。 该流程不使用客户端密钥或授权代码,因为所有应用程序代码和存储都易于访问,因此密钥可能很容易泄漏。

2.3 使用访问令牌访问Gitlab API

访问令牌允许您代表用户向API发出请求。 您可以将令牌作为GET参数传递

GET https://gitlab.example.com/api/v4/user?access_token=OAUTH-TOKEN

或者您可以将令牌放入Authorization标头:

curl --header "Authorization: Bearer OAUTH-TOKEN" https://gitlab.example.com/api/v4/user
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容