/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     ssl_ClientCert.h

  Copyright (C)2009 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 30214 $
 *---------------------------------------------------------------------------*/

#ifndef NN_SSL_SSL_CLIENTCERT_H_
#define NN_SSL_SSL_CLIENTCERT_H_

#include <nn/util/util_NonCopyable.h>
#include <nn/ssl/ssl_Types.h>

#ifdef __cplusplus

namespace nn {
namespace ssl {

class Connection;

/*!
  @brief SSLのクライアント証明書を表すクラスです。一つのSSL通信で使用するクライアント証明書は、その証明書データをClientCertインスタンスに登録後、そのClientCertインスタンスをConnectionクラスに設定することになります。

*/
class ClientCert : private nn::util::NonCopyable<ClientCert>
{
    friend class Connection;
public:
    /*!
      @brief コンストラクタです。
    */
    explicit ClientCert();

    /*!
      @brief デストラクタです。
    */
    virtual ~ClientCert (void);

    /*!
      @brief  証明書と秘密鍵の登録を行い、クライアント証明書を初期化します。
      @param[in]  pCertData   証明書データ。データフォーマットは、X.509 v3の証明書データ(ASN.1定義)をDERエンコードしたバイナリデータ。
      @param[in]  certDataSize pCertDataのサイズ 。
      @param[in]  pPrivateKeyData   秘密鍵のデータ。データフォーマットは、X.509の鍵データ(ASN.1定義)をDERエンコードしたバイナリデータ。
      @param[in]  privateKeyDataSize pPrivateKeyDataのサイズ 。
      @return 関数の実行結果を返します。以下に挙げる Result を返します。<BR>
      @retval ResultSuccess       処理に成功しました。
      @retval ResultProtocolFailedErr 証明書の登録失敗を表すエラー。SSLライブラリに登録されている全証明書数が、システムが許容できる最大数に達している場合などに返ります。自身が登録している証明書の登録解除を行ったり、ある程度の時間を待機することで(その間に他モジュールが登録している証明書を登録解除すれば）、再実行が成功する場合があります。
      @retval ResultNotInitializedErr ライブラリが未初期化を表すエラー。@ref nn::ssl::Initialize が実行されていないと、本ライブラリの関数はすべて利用することができません。
      @retval 上記以外            想定外のエラー(エラー内容については、@ref ssl_Result.h を参照)。
    */
    nn::Result Initialize(const u8* pCertData, size_t certDataSize, const u8* pPrivateKeyData, size_t privateKeyDataSize);

    /*!
      @brief  内蔵証明書を用いて、クライアント証明書を初期化します。
      @param[in]  inClientCertName   内蔵クライアント証明書の名称。
      @return 関数の実行結果を返します。以下に挙げる Result を返します。<BR>
      @retval ResultSuccess       処理に成功しました。
      @retval ResultProtocolFailedErr 証明書の登録失敗を表すエラー。SSLライブラリに登録されている全証明書数が、システムが許容できる最大数に達している場合などに返ります。自身が登録している証明書の登録解除を行ったり、ある程度の時間を待機することで(その間に他モジュールが登録している証明書を登録解除すれば）、再実行が成功する場合があります。
      @retval ResultNotInitializedErr ライブラリが未初期化を表すエラー。@ref nn::ssl::Initialize が実行されていないと、本ライブラリの関数はすべて利用することができません。
      @retval 上記以外            想定外のエラー(エラー内容については、@ref ssl_Result.h を参照)。
    */
    nn::Result Initialize(InternalClientCert inClientCertName);

    /*!
      @brief  クライアント証明書の終了処理を行います。クライアント証明書の利用が全て終了したら、一度実施する必要があります。
      @return 関数の実行結果を返します。以下に挙げる Result を返します。<BR>
      @retval ResultSuccess       処理に成功しました。
      @retval ResultNotInitializedErr ライブラリが未初期化を表すエラー。@ref nn::ssl::Initialize が実行されていないと、本ライブラリの関数はすべて利用することができません。
      @retval 上記以外            想定外のエラー(エラー内容については、@ref ssl_Result.h を参照)。
    */
    nn::Result Finalize(void);

    /*!
      @brief  クライアント証明書のIDを取得します。
      @return クライアント証明書のID <BR>
    */
    CertId GetID(void){return m_certId;}

private:
    bool m_isInitialized;
    NN_PADDING3;
    CertId m_certId;

    /*!
      @brief  クライアント証明書が有効なものか否かを取得します。
      @return 処理の結果が返ります。<BR>
    */
    bool IsValid(){return m_isInitialized;}
};

} // end of namespace ssl
} // end of namespace nn

#endif // __cplusplus


#include <nn/util/detail/util_CLibImpl.h>


/*!
  @addtogroup   nn_ssl               ssl
  @{

  @defgroup     nn_ssl_ClientCert_c    ClientCert (C)

  @brief        @ref nn::ssl::ClientCert の C インタフェースモジュールです。

  @{
*/

/*!
  @struct       nnsslClientCert
  @brief        SSLのClientCertを表す C の構造体です。

  @brief 対応するクラス @ref nn::ssl::ClientCert を参照してください。
*/
NN_UTIL_DETAIL_CLIBIMPL_DEFINE_BUFFER_CLASS(nnsslClientCert, nn::ssl::ClientCert, 12, u32);

/*!
  @brief 対応する C++ 関数 @ref nn::ssl::ClientCert::Initialize
*/
NN_EXTERN_C nnResult nnsslClientCertInitialize(nnsslClientCert* this_, const u8* pCertData, size_t certDataSize, const u8* pPrivateKeyData, size_t privateKeyDataSize);

/*!
  @brief 対応する C++ 関数 @ref nn::ssl::ClientCert::Initialize
*/
NN_EXTERN_C nnResult nnsslClientCertInitByInternalCert(nnsslClientCert* this_, NnSslInternalClientCert inClientCertName);


/*!
  @brief 対応する C++ 関数 @ref nn::ssl::ClientCert::Finalize
*/
NN_EXTERN_C nnResult nnsslClientCertFinalize(nnsslClientCert* this_);


/*!
  @}

  @}
*/

#endif /* NN_SSL_SSL_CLIENTCERT_H_ */