linux-sgx-trts-modified/psw/ae/aesm_service/source/aesm/extension/endpoint_select_info.h

/*
 * Copyright (C) 2011-2017 Intel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef _ENDPOINT_SELECT_INFO_H_
#define _ENDPOINT_SELECT_INFO_H_
#include "se_types.h"
#include "sgx_tseal.h"
#include "aeerror.h"
#include "se_thread.h"
#include "internal/se_rwlock.h"
#include "oal/oal.h"
#include "se_wrapper.h"
#include <time.h>
#include <string.h>
#include "epid_pve_type.h"
#include "default_url_info.hh"
#include "AEClass.h"
#include "aesm_logic.h"

#define AESM_DATA_SERVER_URL_INFOS          'A'
#define AESM_DATA_ENDPOINT_SELECTION_INFOS  'B'
#define AESM_DATA_SERVER_URL_VERSION_1       1
#define AESM_DATA_SERVER_URL_VERSION         2
#define AESM_DATA_ENDPOINT_SELECTION_VERSION 1
#pragma pack(1)
#include "aesm_config.h"

/*Struct for PCE based url information which will be installed by PSW Installer*/
typedef struct _aesm_server_url_infos_t{
    uint8_t aesm_data_type;
    uint8_t aesm_data_version;
    char endpoint_url[MAX_PATH]; /*URL for endpoint selection protocol server*/
    char pse_rl_url[MAX_PATH];   /*URL to retrieve PSE rovocation List*/
    char pse_ocsp_url[MAX_PATH]; 
}aesm_server_url_infos_t;

/*Struct for data to save endpoint selection protocol result into persistent data storage*/
typedef struct _endpoint_selection_infos_t{
    uint8_t      aesm_data_type;
    uint8_t      aesm_data_version;
    signed_pek_t pek;
    char         provision_url[MAX_PATH];
}endpoint_selection_infos_t;
#pragma pack()

/*An interface to provide the endpoint selection protocol and also provide some URLs (result of ES protocol or some static url)
 *Singleton class used to provide a singleton instance in memory and lock used so that it could be shared by PvE/PSEPR
 *EndpointSelectionInfo::instance().start_protocol(...) could be used to get endpoint selection result
 *   It will restart the ES protocol to get updated data. If the protocol fails, it may reuse existing endpoint selection protocol result in persistent storage
 */
class EndpointSelectionInfo: public Singleton<EndpointSelectionInfo>{
    CLASS_UNCOPYABLE(EndpointSelectionInfo);
    friend class Singleton<EndpointSelectionInfo>;
private:
    AESMLogicMutex _es_lock;              /*lock used since the data will be accessed by two different components: PSEPR and PVE*/
    aesm_config_infos_t _config_urls;     /*some readonly urls not related to XEGD*/
    aesm_server_url_infos_t _server_urls; /*XEGD based readonly url*/
    bool _is_server_url_valid;            /*Set it to true when field _server_urls is valid*/
    bool _is_white_list_url_valid;        /*Set it to true after reading _config_urls*/
    static ae_error_t read_pek(endpoint_selection_infos_t& es_info); /*read _es_info from persistent storage*/
    static ae_error_t write_pek(const endpoint_selection_infos_t& es_info); /*save _es_info to persistent storage*/
    ae_error_t verify_signature(const endpoint_selection_infos_t& es_info, uint8_t xid[XID_SIZE], uint8_t rsa_signature[PVE_RSA_KEY_BYTES], uint16_t ttl); /*verify rsa signature in ES protocol result*/
public:
    EndpointSelectionInfo(){
        memset(&_server_urls, 0, sizeof(_server_urls));
        memset(&_config_urls, 0, sizeof(_config_urls));
        _is_white_list_url_valid=false;
        _is_server_url_valid=false;
    }
    const char *get_pse_provisioning_url(const endpoint_selection_infos_t& es_info);
public:
    static ae_error_t verify_file_by_xgid(uint32_t xgid);
    const char* get_dal_emulator_url(){return NULL;}/*dal emulator not supported. The interface is kept to keep PSE untrusted code compilable*/
    ae_error_t get_url_info();
    ae_error_t get_url_info(aesm_server_url_infos_t& server_url);
    const char *get_server_url(aesm_network_server_enum_type_t type);
    void  get_proxy(uint32_t& proxy_type, char proxy_url[MAX_PATH]);
    /*Function to get result of Endpoint Selection Protocol from Backend Server*/
    ae_error_t start_protocol(endpoint_selection_infos_t& es_info);
};
#endif /*_ENDPOINT_SELECT_INFO_H_*/