OAuth2.0和C++ REST SDK使用示例

目标

现在各大网站均可以使用一些已有其它账户(微信、微博等)登录,而不需要为其申请账户和密码,其中使用的授权协议有一种是OAuth。
以下将演示如何使用C++ REST SDK和OAuth2.0协议,实现一个console客户端,进行Windows Live身份验证,并获取一些用户的基本信息。

OAuth2.0

关于OAuth的基本知识可以阅读以下链接的内容:

准备环境

本文开发环境为Visual Studio 2015,C++ REST SDK;

使用Vcpkg安装C++ REST SDK:

//下载vcpkg
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
//构造
powershell -exec bypass scripts\bootstrap.ps1
//整合到Visual Studio 2015
vcpkg integrate install
//安装C++ REST SDK
vcpkg install cpprestsdk

客户端准备

编写客户端使用OAuth授权时,需要到对应的服务商申请客户端ID和密钥,一般在谷歌中搜索类似" Windows Live OAuth2"即可得到对应的服务商说明;
我们需要查阅服务商的开发者文档来查看其是否支持OAuth,如何通过其进行授权,譬如微软对应的 OAuth 2.0即描述了其对OAuth2.0的支持,以及开发说明;而Registering Your Application with Windows Live则描述了如何注册客户端到"Windows Live"。

实现流程

采用的是客户端授权模式中的授权码模式,授权流程如下:

来自阮一峰博客的授权流程

客户端(Windows Live 应用程序)配置

  • 应用程序ID
  • 应用程序密码
  • 平台:Web
  • 重定向URI:http://localhost:8890
  • 勾选Live SDK支持

如何实现

OAuth2.0配置信息

C++ REST SDK中关于OAuth2的所有配置及最终获取到的访问令牌均存储在oauth2_config中,构造时需要的信息有:

  • client_key:客户端ID
  • client_secret:客户端密码
  • auth_endpoint:认证服务器端口
  • token_endpoint:令牌服务器端口
  • redirect_uri:重定向URI
  • scope :授权请求范围

构造示例如下:

static const utility::string_t s_live_key(U("40654b2b-feda-4733-8499-584017f37c4e"));
static const utility::string_t s_live_secret(U("zL4fsEUOTHr8b8Ppm6bJhM9"));

oauth2_config config(s_live_key,
    s_live_secret,
    U("https://login.live.com/oauth20_authorize.srf"),
    U("https://login.live.com/oauth20_token.srf"),
    U("http://localhost:8890/"));

导向认证服务器

客户端需要构造申请认证的URI,并将用户导向认证服务器;
构造申请认证所需的URI,可以直接使用oauth2_configbuild_authorization_uri方法;

打开浏览器的实现如下:

//used to open browser
#include <Windows.h>
#include <shellapi.h>
static void open_browser(utility::string_t auth_uri)
{
    auto r = ::ShellExecuteA(nullptr,"open",
        conversions::utf16_to_utf8(auth_uri).c_str(),NULL,NULL,SW_SHOWNORMAL);
}

对应流程实现如下:

void open_browser_auth()
{
    auto auth_uri(m_oauth2_config.build_authorization_uri(true));
    ucout<<"Opening browser in URI:" << std::endl;
    ucout<<auth_uri<<std::endl;
    open_browser(auth_uri);
}

获取用户授权码

当用户给予授权后,认证服务器会将用户导向客户端事先指定的“重定向URI”并附上授权码,我们需要创建一个临时的HTTP Listener来监控返回的信息拿到授权码:

一个简单的HTTP Listener实现如下:

class OAuth2_listener
{
public:
    OAuth2_listener(uri listen_uri):
        m_listener(new http_listener(listen_uri))
    {
        m_listener->support([this](http_request request)->void {
            //处理HTTP 请求
            if (request.request_uri().path() == U("/") &&
                request.request_uri().query() != U(""))
            {
                m_lock.lock();
                
                //处理返回的授权码,并设置为完成
                m_tce.set(true);
 
                request.reply(status_codes::OK, U("Ok."));
                m_lock.unlock();
            }
            else
            {
                request.reply(status_codes::NotFound, U("Not found"));
            }
        });
        m_listener->open().wait();//打开HTTP 监听
    }
 
    ~OAuth2_listener()
    {
        m_listener->close().wait();//关闭HTTP Listener
    }
 
    pplx::task<bool> listen_for_code()
    {
        return pplx::create_task(m_tce); //等待认证服务器的授权码
    }
private:
    std::unique_ptr<http_listener> m_listener; //HTTP监听
    pplx::task_completion_event<bool> m_tce;//收到授权码的确认事件
    std::mutex m_lock;
};

使用OAuth2_listener.listen_for_code().get()即可得到授权码。

获取访问令牌

拿到授权码之后,则需要向认证服务器申请令牌;在oauth2_config中有方法实现了这样的操作:

根据重定向URI获取令牌

其操作步骤是获取URI中的CODE,然后请求令牌,并将获取的令牌保存到oauth2_config中,调整HTTP Listener中处理授权码的部分:

//处理返回的授权码
//m_tce.set(true);
m_config.token_from_redirected_uri(request.request_uri()).then(
    [this, request](pplx::task<void> token_task)->void {
    try
    {
        token_task.wait();
        m_tce.set(true);
    }
    catch (const oauth2_exception& e)
    {
        ucout << "Error: " << e.what() << std::endl;
        m_tce.set(false);
    }
    catch (const http_exception& he)
    {
        ucout << "Error: " << he.what() << std::endl;
        m_tce.set(false);
    }
});

经过这样的处理之后,访问令牌就保存到了oauth2_config中。

集成授权流程

经过上述操作,即可拿到令牌,而在http_client_config中有接口set_oauth2可以将之前的存有令牌的oauth2_config保存到客户端配置中,之后就可以按照常规的HTTP/HTTPS操作获取用户信息了:

public:
    http_client_config m_http_config;
    oauth2_config m_oauth2_config;
    std::unique_ptr<OAuth2_listener> m_listener_;
    void work()
    {
        if (!m_oauth2_config.client_key().empty() &&
            !m_oauth2_config.client_secret().empty())
        {
            if (!m_oauth2_config.token().is_valid_access_token())
            {
                if (m_listener_->listen_for_code().get())
                {
                    m_http_config.set_oauth2(m_oauth2_config);//保存令牌及信息到http配置
                }
                else
                {
                    //授权失败
                }
            }
            else
            {
                //令牌已有效
            }
 
            //发起获取用户信息请求
        }
        else
        {
            //没有有效的客户端信息
        }
    }

获取用户信息

以下是获取Windows Live上用户信息的简单示例:

http_client api(U("https://apis.live.net/v5.0/"),m_http_config);
ucout << "Requesting account information:"<<std::endl;
ucout << api.request(methods::GET,U("me")).get().extract_json().get() << std::endl;

输出结果如图:

用户信息

收获

上述源代码主要来自于C++ REST SDK中的OAuth2.0示例,但是在具体分析和使用的过程中还是遇到了很多问题:申请Application时的配置,无法获取令牌,运行时崩溃等等;

为了定位无法获取令牌的问题,重写了一遍 token_from_redirected_uri,梳理了实现流程,最终发现是设置了HTTP Client的proxy所致,最新的代码应该不存在这个问题。

实际上OAuth2就是通过HTTP进行多次交互获取访问令牌,C++ REST SDK提供了HTTP通信功能,自己也可以完成整个OAuth2的授权流程。

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,495评论 18 139
  • 以下是官网直译:https://oauth.net/ 1. 首页 OAuth是一种开放协议(注:协议是公开的,任何...
    KennethChen93阅读 11,105评论 0 20
  • 原文地址:http://www.sanjinbest.com/blog/b6ec839d56c04ca387b95...
    木子小三金阅读 8,527评论 0 37
  • 什么是三方授权? 第三方授权就是,委托第三方来对既定的用户进行鉴定,鉴定成功之后,下发信任凭证,信任凭证和用户挂钩...
    一只小哈阅读 32,429评论 2 21
  • 我不敢去打破现在的格局,我怕我连最后的你我都会失去掉,如果可以静静地看着你,我内心也是很心满意足的,梦里,和你表白...
    小小钟阅读 172评论 0 0