nugu_auth.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2022 SK Telecom Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NUGU_AUTH_H__
#define __NUGU_AUTH_H__
 
#include <string>
#include <vector>
 
#include <clientkit/nugu_http_rest.hh>
#include <nugu.h>
 
namespace NuguClientKit {
 
enum GrantType {
    AUTHORIZATION_CODE = 0x1, /* OAuth2 Authorization code */
    CLIENT_CREDENTIALS = 0x2, /* OAuth2 Client credentials */
    REFRESH_TOKEN = 0x4, /* OAuth2 refresh token */
    DEVICE_CODE = 0x8 /* OAuth2 device code */
};
 
struct NuguDeviceConfig {
    std::string oauth_server_url; /* OAuth2 server url */
    std::string oauth_client_id; /* Client id */
    std::string oauth_client_secret; /* Client secret */
    std::string oauth_redirect_uri; /* Redirect uri */
    std::string device_type_code; /* Device type code */
    std::string poc_id; /* PoC id */
};
 
struct NuguToken {
    std::string access_token; /* OAuth2 access token */
    std::string refresh_token; /* OAuth2 refresh token */
    std::string token_type; /* OAuth2 token type. e.g. "Bearer" */
    int expires_in; /* Expiration time remaining after token issuance (secs) */
    time_t timestamp; /* Token issuance time */
 
    std::vector<std::string> scope; /* scope */
    int exp; /* Token expiration time (unix timestamp) */
    std::string client_id; /* OAuth2 client id */
    std::string ext_usr; /* user id */
    std::string ext_dvc; /* device id */
    std::string ext_srl; /* device serial */
    std::string ext_poc; /* PoC id */
 
    bool sid; /* flag for server-initiative-directive support */
};
 
struct AuthResponse {
    int code; /* HTTP Response code */
    std::string body; /* HTTP Response body */
};
 
class NUGU_API NuguAuth {
public:
    explicit NuguAuth(const NuguDeviceConfig& config);
    ~NuguAuth();
 
    bool discovery(struct AuthResponse* response = nullptr);
 
    bool discovery(const std::function<void(bool success, const struct AuthResponse* response)>& cb);
 
    bool isSupport(const GrantType& gtype);
 
    std::string generateAuthorizeUrl(const std::string& device_serial);
 
    NuguToken* getAuthorizationCodeToken(const std::string& code, const std::string& device_serial,
        struct AuthResponse* response = nullptr);
 
    NuguToken* getClientCredentialsToken(const std::string& device_serial,
        struct AuthResponse* response = nullptr);
 
    bool parseAccessToken(NuguToken* token);
 
    bool refresh(NuguToken* token, const std::string& device_serial = "",
        struct AuthResponse* response = nullptr);
 
    bool isExpired(const NuguToken* token, time_t base_time = 0);
 
    time_t getRemainExpireTime(const NuguToken* token, time_t base_time = 0);
 
    std::string getGatewayRegistryUri();
 
    std::string getTemplateServerUri();
 
private:
    bool parseDiscoveryResult(const std::string& response);
    bool parseAndSaveToken(const std::string& response, NuguToken* token);
 
    NuguDeviceConfig config;
    NuguHttpRest* rest;
    unsigned int supported_grant_types;
    std::string ep_token;
    std::string ep_authorization;
    std::string uri_gateway_registry;
    std::string uri_template_server;
};
 
} // NuguClientKit
 
#endif /* __NUGU_AUTH_H__ */