hxauth.h
上传用户:dangjiwu
上传日期:2013-07-19
资源大小:42019k
文件大小:12k
源码类别:

Symbian

开发平台:

Visual C++

  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Source last modified: $Id: hxauth.h,v 1.1.1.1.50.3 2004/07/09 01:45:08 hubbe Exp $
  3.  * 
  4.  * Portions Copyright (c) 1995-2004 RealNetworks, Inc. All Rights Reserved.
  5.  * 
  6.  * The contents of this file, and the files included with this file,
  7.  * are subject to the current version of the RealNetworks Public
  8.  * Source License (the "RPSL") available at
  9.  * http://www.helixcommunity.org/content/rpsl unless you have licensed
  10.  * the file under the current version of the RealNetworks Community
  11.  * Source License (the "RCSL") available at
  12.  * http://www.helixcommunity.org/content/rcsl, in which case the RCSL
  13.  * will apply. You may also obtain the license terms directly from
  14.  * RealNetworks.  You may not use this file except in compliance with
  15.  * the RPSL or, if you have a valid RCSL with RealNetworks applicable
  16.  * to this file, the RCSL.  Please see the applicable RPSL or RCSL for
  17.  * the rights, obligations and limitations governing use of the
  18.  * contents of the file.
  19.  * 
  20.  * Alternatively, the contents of this file may be used under the
  21.  * terms of the GNU General Public License Version 2 or later (the
  22.  * "GPL") in which case the provisions of the GPL are applicable
  23.  * instead of those above. If you wish to allow use of your version of
  24.  * this file only under the terms of the GPL, and not to allow others
  25.  * to use your version of this file under the terms of either the RPSL
  26.  * or RCSL, indicate your decision by deleting the provisions above
  27.  * and replace them with the notice and other provisions required by
  28.  * the GPL. If you do not delete the provisions above, a recipient may
  29.  * use your version of this file under the terms of any one of the
  30.  * RPSL, the RCSL or the GPL.
  31.  * 
  32.  * This file is part of the Helix DNA Technology. RealNetworks is the
  33.  * developer of the Original Code and owns the copyrights in the
  34.  * portions it created.
  35.  * 
  36.  * This file, and the files included with this file, is distributed
  37.  * and made available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY
  38.  * KIND, EITHER EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS
  39.  * ALL SUCH WARRANTIES, INCLUDING WITHOUT LIMITATION, ANY WARRANTIES
  40.  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, QUIET
  41.  * ENJOYMENT OR NON-INFRINGEMENT.
  42.  * 
  43.  * Technology Compatibility Kit Test Suite(s) Location:
  44.  *    http://www.helixcommunity.org/content/tck
  45.  * 
  46.  * Contributor(s):
  47.  * 
  48.  * ***** END LICENSE BLOCK ***** */
  49. #ifndef _HXAUTH_H_
  50. #define _HXAUTH_H_
  51. /*
  52.  * Forward declarations of some interfaces defined or used here-in.
  53.  */
  54. typedef _INTERFACE  IHXAuthenticator     IHXAuthenticator;
  55. typedef _INTERFACE  IHXAuthenticatorResponse     IHXAuthenticatorResponse;
  56. typedef _INTERFACE  IHXAuthenticatorRequest     IHXAuthenticatorRequest;
  57. typedef _INTERFACE  IHXPassword     IHXPassword;
  58. typedef _INTERFACE  IHXAuthenticationManagerResponse IHXAuthenticationManagerResponse;
  59. typedef _INTERFACE  IHXValues     IHXValues;
  60. typedef _INTERFACE  IHXBuffer     IHXBuffer;
  61. /****************************************************************************
  62.  * 
  63.  *  Interface:
  64.  * 
  65.  *      IHXAuthenticator
  66.  * 
  67.  *  Purpose:
  68.  * 
  69.  *      Provide a means of authenticating users.
  70.  *
  71.  *  IID_IHXAuthenticator:
  72.  * 
  73.  *      {00001800-0901-11d1-8B06-00A024406D59}
  74.  * 
  75.  */
  76. DEFINE_GUID(IID_IHXAuthenticator, 0x00001800, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  77. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  78. #define CLSID_IHXAuthenticator IID_IHXAuthenticator
  79. #undef  INTERFACE
  80. #define INTERFACE IHXAuthenticator
  81. DECLARE_INTERFACE_(IHXAuthenticator, IUnknown)
  82. {
  83.     STDMETHOD(QueryInterface)           (THIS_
  84. REFIID riid,
  85. void** ppvObj) PURE;
  86.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  87.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  88.     /*
  89.      * InitAuthenticator is called by the creator of the Authenticator
  90.      * object in order to pass it an IHXAuthenticatorRequest object,
  91.      * usually implemented by the creator itself.
  92.      */
  93.     STDMETHOD(InitAuthenticator) (THIS_ 
  94.   IHXAuthenticatorRequest* pRequest) PURE;
  95.     /*
  96.      * Authenticate is called by a file object (and others??)
  97.      * when it wants to ask the creator, presumably an FS Manager,
  98.      * for authorization to open it's file.
  99.      *
  100.      * Authenticate will call IHXAuthenticateResponse::AuthenticateDone
  101.      * when done with HXR_OK or an error.
  102.      *
  103.      * File objects will presumably perform the Authenticate response as
  104.      * part of their Init() call, and not call InitDone until they receive
  105.      * a response one way or the other.
  106.      */
  107.     STDMETHOD(Authenticate) (THIS_
  108.      IHXValues* pValues,
  109.      IHXAuthenticatorResponse* pResponse) PURE;
  110.     /* GenerateAuthRequest is called by the creator of this object
  111.      * when they want to send an authentication request to someone.
  112.      */
  113.     STDMETHOD(GenerateAuthRequest) (THIS_
  114.     UINT32 authType,
  115.     REF(IHXValues*) pValues) PURE;
  116.     /*
  117.      * AuthValuesReady is called by IHXAuthenticatorRequest when it
  118.      * is ready to respond to a GetAuthValues request.
  119.      */
  120.     STDMETHOD(AuthValuesReady) (THIS_ 
  121. HX_RESULT result,
  122. IHXValues* pValues) PURE;
  123. };
  124. /****************************************************************************
  125.  * 
  126.  *  Interface:
  127.  * 
  128.  *      IHXAuthenticatorResponse
  129.  * 
  130.  *  Purpose:
  131.  *
  132.  *      Response object for the Authenticator class.
  133.  * 
  134.  *  IID_IHXAuthenticatorResponse:
  135.  * 
  136.  *      {00001801-0901-11d1-8B06-00A024406D59}
  137.  * 
  138.  */
  139. DEFINE_GUID(IID_IHXAuthenticatorResponse, 0x00001801, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  140. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  141. #undef  INTERFACE
  142. #define INTERFACE IHXAuthenticatorResponse
  143. DECLARE_INTERFACE_(IHXAuthenticatorResponse, IUnknown)
  144. {
  145.     STDMETHOD(QueryInterface)           (THIS_
  146. REFIID riid,
  147. void** ppvObj) PURE;
  148.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  149.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  150.     /* AuthenticateDone is called by an IHXAuthenticator when it has
  151.      * finished it's authorization steps.  If the result is HXR_OK,
  152.      * then the values contain authorization information as generated by
  153.      * IHXPassword.
  154.      */
  155.     STDMETHOD(AuthenticateDone) (THIS_ HX_RESULT result,
  156. IHXValues* pAuthResponseValues) PURE;
  157. };
  158. /****************************************************************************
  159.  * 
  160.  *  Interface:
  161.  * 
  162.  *      IHXAuthenticatorRequest
  163.  * 
  164.  *  Purpose:
  165.  *
  166.  *      Request object for the Authenticator class.
  167.  * 
  168.  *  IID_IHXAuthenticatorRequest:
  169.  * 
  170.  *      {00001802-0901-11d1-8B06-00A024406D59}
  171.  * 
  172.  */
  173. DEFINE_GUID(IID_IHXAuthenticatorRequest, 0x00001802, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  174. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  175. #undef  INTERFACE
  176. #define INTERFACE IHXAuthenticatorRequest
  177. DECLARE_INTERFACE_(IHXAuthenticatorRequest, IUnknown)
  178. {
  179.     STDMETHOD(QueryInterface)           (THIS_
  180. REFIID riid,
  181. void** ppvObj) PURE;
  182.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  183.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  184.     /* GetAuthValues is called by the Authenticator object when it
  185.      * needs to know the authorization info for this transaction.
  186.      *
  187.      * This object should call AuthValuesReady when ready.
  188.      */
  189.     STDMETHOD(GetAuthValues) (THIS_ IHXValues* pOrigValues) PURE;
  190. };
  191. /****************************************************************************
  192.  * 
  193.  *  Interface:
  194.  * 
  195.  *      IHXPassword
  196.  * 
  197.  *  Purpose:
  198.  * 
  199.  *      Provides a general password facility for storing of passwords in
  200.  * an encrypted form and a facility for verifying passwords securely
  201.  * over the network.
  202.  * 
  203.  *  IID_IHXPassword:
  204.  * 
  205.  *      {00001700-0901-11d1-8B06-00A024406D59}
  206.  * 
  207.  */
  208. #define HX_AUTH_BASIC 1
  209. #define HX_AUTH_DIGEST 2
  210. #define PN_AUTH_HX5 3
  211. #define HX_AUTH_NTLM 4
  212. DEFINE_GUID(IID_IHXPassword, 0x00001700, 0x901, 0x11d1, 0x8b, 0x6, 0x0, 
  213. 0xa0, 0x24, 0x40, 0x6d, 0x59);
  214. #undef  INTERFACE
  215. #define INTERFACE IHXPassword
  216. DECLARE_INTERFACE_(IHXPassword, IUnknown)
  217. {
  218.     /*
  219.      *  IUnknown methods
  220.      */
  221.     STDMETHOD(QueryInterface)           (THIS_
  222. REFIID riid,
  223. void** ppvObj) PURE;
  224.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  225.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  226.     /*
  227.      *  IHXPassword methods
  228.      */
  229.     STDMETHOD(Crypt) (THIS_ IHXValues* pAuthentication) PURE;
  230.     STDMETHOD(Verify) (THIS_ IHXValues* pAuth1, IHXValues* pAuth2) PURE;
  231.     STDMETHOD(AsString) (THIS_ IHXValues* pAuth, REF(IHXBuffer*) pBuffer) PURE;
  232.     STDMETHOD(AsValues) (THIS_ const char* str, IHXValues* pValues) PURE;
  233.     /*
  234.      * CreateBuffer is provided for the convenince of external users,
  235.      * who would otherwise have to get a context and common class factory
  236.      * just to create IHXBuffers.  This method can be used instead, but
  237.      * is not advisable if other means are available.
  238.      */
  239.     STDMETHOD(CreateBuffer) (THIS_ REF(IHXBuffer*) pBuffer) PURE;
  240.     /*
  241.      * Ditto for CreateValues
  242.      */
  243.     STDMETHOD(CreateValues) (THIS_ REF(IHXValues*) pValues) PURE;
  244. };
  245. /****************************************************************************
  246.  * 
  247.  *  Interface:
  248.  * 
  249.  *      IHXAuthenticationManager
  250.  * 
  251.  *  Purpose:
  252.  * 
  253.  *      Provide a means of authenticating users.
  254.  *
  255.  *  IID_IHXAuthenticator:
  256.  * 
  257.  *      {00001a00-0901-11d1-8B06-00A024406D59}
  258.  * 
  259.  */
  260. DEFINE_GUID(IID_IHXAuthenticationManager, 0x00001a00, 0x901, 0x11d1,
  261.     0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59);
  262. #undef  INTERFACE
  263. #define INTERFACE IHXAuthenticationManager
  264. DECLARE_INTERFACE_(IHXAuthenticationManager, IUnknown)
  265. {
  266.     STDMETHOD(QueryInterface)           (THIS_
  267. REFIID riid,
  268. void** ppvObj) PURE;
  269.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  270.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  271.     /* HandleAuthenticationRequest is called when the core wants us to get
  272.      * a username and password.
  273.      */
  274.     STDMETHOD(HandleAuthenticationRequest) (
  275. THIS_ IHXAuthenticationManagerResponse* pResponse) PURE;
  276. };
  277. /****************************************************************************
  278.  * 
  279.  *  Interface:
  280.  * 
  281.  *      IHXAuthenticationManager2
  282.  * 
  283.  *  Purpose:
  284.  * 
  285.  *      Provide a means of authenticating users.
  286.  *
  287.  *      Includes sending an IHXValues list to the
  288.  *      authentication manager, for support of proxy
  289.  *      authentication, for example, which may include
  290.  *      a "pseudonym" header or something.
  291.  *
  292.  *  IID_IHXAuthenticator2:
  293.  * 
  294.  *      {34e171d2-a8f0-4832-bc7d-06dfe3ae58fd}
  295.  * 
  296.  */
  297. DEFINE_GUID(IID_IHXAuthenticationManager2,
  298.  0x34e171d2,  0xa8f0,  0x4832,  0xbc,  0x7d,  0x06,
  299.  0xdf,  0xe3,  0xae,  0x58,  0xfd);
  300. #undef  INTERFACE
  301. #define INTERFACE IHXAuthenticationManager2
  302. DECLARE_INTERFACE_(IHXAuthenticationManager2, IUnknown)
  303. {
  304.     STDMETHOD(QueryInterface)           (THIS_
  305. REFIID riid,
  306. void** ppvObj) PURE;
  307.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  308.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  309.     /* HandleAuthenticationRequest2 is called when the core wants us to get
  310.      * a username and password.
  311.      */
  312.     STDMETHOD(HandleAuthenticationRequest2) (
  313. THIS_
  314. IHXAuthenticationManagerResponse* pResponse,
  315. IHXValues* pHeader) PURE;
  316. };
  317. /****************************************************************************
  318.  * 
  319.  *  Interface:
  320.  * 
  321.  *      IHXAuthenticationManagerResponse
  322.  * 
  323.  *  Purpose:
  324.  * 
  325.  *      Response object for IHXAuthenticationManager.
  326.  *
  327.  *  IID_IHXAuthenticator:
  328.  * 
  329.  *      {00001a01-0901-11d1-8B06-00A024406D59}
  330.  * 
  331.  */
  332. DEFINE_GUID(IID_IHXAuthenticationManagerResponse, 0x00001a01, 0x901, 0x11d1,
  333.             0x8b, 0x6, 0x0, 0xa0, 0x24, 0x40, 0x6d, 0x59); 
  334. #undef  INTERFACE
  335. #define INTERFACE IHXAuthenticationManagerResponse
  336. DECLARE_INTERFACE_(IHXAuthenticationManagerResponse, IUnknown)
  337. {
  338.     STDMETHOD(QueryInterface)           (THIS_
  339. REFIID riid,
  340. void** ppvObj) PURE;
  341.     STDMETHOD_(ULONG32,AddRef)          (THIS) PURE;
  342.     STDMETHOD_(ULONG32,Release)         (THIS) PURE;
  343.     /* HandleAuthenticationRequest is called when the core wants us to get
  344.      * a username and password.
  345.      */
  346.     STDMETHOD(AuthenticationRequestDone) (THIS_
  347.   HX_RESULT result,
  348.   const char* pUserName,
  349.   const char* pPassword) PURE;
  350. };
  351. #ifdef _MACINTOSH
  352. #pragma export on
  353. #endif
  354. STDAPI CreatePassword(IUnknown** /* OUT */ ppIUnknown);
  355. #ifdef _MACINTOSH
  356. #pragma export off
  357. #endif
  358. #endif /* _HXAUTH_H_ */