📄 wzcsapi.h
字号:
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//
// Use of this source code is subject to the terms of the Microsoft end-user
// license agreement (EULA) under which you licensed this SOFTWARE PRODUCT.
// If you did not accept the terms of the EULA, you are not authorized to use
// this source code. For a copy of the EULA, please see the LICENSE.RTF on your
// install media.
//
/*++
THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE.
Module Name:
wzcsapi.h
Abstract:
API for Wireless Zero Configuration interface.
Notes:
--*/
#ifndef _WZCAPI_H_
#define _WZCAPI_H_
#ifdef UNDER_CE
#ifdef MIDL_PASS
#undef MIDL_PASS
#endif
#endif
#pragma once
# ifdef __cplusplus
extern "C" {
# endif
#ifndef UNDER_CE
PVOID
MIDL_user_allocate(size_t NumBytes);
VOID
MIDL_user_free(void * MemPointer);
#endif // UNDER_CE
//---------------------------------------
// Macros for handling additional attributes on WZC_WLAN_CONFIG structures
// Coding of additional attributes in the Reserved bytes of WZC_WLAN_CONFIG objects:
// Reserved
// [1] [0]
// ---SSSAA CCCCCCCC
// SSS = [0-7; used: 0-6] selection set category, one of VPI, VI, PI, VPA, VA, PA, N
// AA = [0-3; used: 0-3] authentication mode, NDIS_802_11_AUTHENTICATION_MODE value
// CCCCCCCC = [0-255] retry counter for this object.
//
#define NWB_AUTHMODE_MASK 0x03
#define NWB_SELCATEG_MASK 0x1C
#ifndef UNDER_CE
#define NWB_SET_AUTHMODE(pNWB, nAM) (pNWB)->Reserved[1] = (((pNWB)->Reserved[1] & ~NWB_AUTHMODE_MASK) | ((nAM) & NWB_AUTHMODE_MASK))
#define NWB_GET_AUTHMODE(pNWB) ((pNWB)->Reserved[1] & NWB_AUTHMODE_MASK)
#define NWB_SET_SELCATEG(pNWB, nSC) (pNWB)->Reserved[1] = (((pNWB)->Reserved[1] & ~NWB_SELCATEG_MASK) | (((nSC)<<2) & NWB_SELCATEG_MASK))
#define NWB_GET_SELCATEG(pNWB) (((pNWB)->Reserved[1] & NWB_SELCATEG_MASK)>>2)
#else
#define NWB_SET_AUTHMODE(pNWB, nAM) (pNWB)->Reserved[1] = (UCHAR)(((pNWB)->Reserved[1] & ~NWB_AUTHMODE_MASK) | ((nAM) & NWB_AUTHMODE_MASK))
#define NWB_GET_AUTHMODE(pNWB) ((pNWB)->Reserved[1] & NWB_AUTHMODE_MASK)
#define NWB_SET_SELCATEG(pNWB, nSC) (pNWB)->Reserved[1] = (UCHAR)(((pNWB)->Reserved[1] & ~NWB_SELCATEG_MASK) | (((nSC)<<2) & NWB_SELCATEG_MASK))
#define NWB_GET_SELCATEG(pNWB) (((pNWB)->Reserved[1] & NWB_SELCATEG_MASK)>>2)
#endif
//---------------------------------------
// [P]RAW_DATA: generic description of a BLOB
typedef struct
{
DWORD dwDataLen;
#if defined(MIDL_PASS)
[unique, size_is(dwDataLen)] LPBYTE pData;
#else
LPBYTE pData;
#endif
} RAW_DATA, *PRAW_DATA;
#include <windot11.h>
#include <wlclient.h>
#if !defined(MIDL_PASS)
#include <ntddndis.h>
#ifdef UNDER_CE
typedef struct _WZC_EAPOL_PARAMS
{
BOOL bEnable8021x;
DWORD dwEapFlags;
DWORD dwEapType;
DWORD dwAuthDataLen;
BYTE *pbAuthData; // Pointer to provider specific config blob
} WZC_EAPOL_PARAMS, *PWZC_EAPOL_PARAMS;
//typedef struct _EAP_EXTENSIONS
//{
// DWORD dwNumOfExtension;
// PEAP_EXTENSION_INFO pEapExtensionInfo;
//
//} EAP_EXTENSIONS, *PEAP_EXTENSIONS;
#endif
#define WZCCTL_MAX_WEPK_MATERIAL 32
#define WZCCTL_WEPK_PRESENT 0x0001 // specifies whether the configuration includes or not a WEP key
#define WZCCTL_WEPK_XFORMAT 0x0002 // the WEP Key material (if any) is entered as hexadecimal digits
#define WZCCTL_VOLATILE 0x0004 // this configuration should not be stored
#define WZCCTL_POLICY 0x0008 // this configuration is enforced by the policy
#define WZCCTL_ONEX_ENABLED 0x0010 // for this configuration 802.1X should be enabled
//---------------------------------------
// [P]WZC_WLAN_CONFIG: like NDIS_WLAN_BSSID, but contains all the additional
// data that defines a [Preferred] Wireless Zero Configuration
typedef struct
{
ULONG Length; // Length of this structure
DWORD dwCtlFlags; // control flags (NON-NDIS) see WZC_WEPK* constants
// fields from the NDIS_WLAN_BSSID structure
NDIS_802_11_MAC_ADDRESS MacAddress; // BSSID
UCHAR Reserved[2];
NDIS_802_11_SSID Ssid; // SSID
ULONG Privacy; // WEP encryption requirement
NDIS_802_11_RSSI Rssi; // receive signal strength in dBm
NDIS_802_11_NETWORK_TYPE NetworkTypeInUse;
NDIS_802_11_CONFIGURATION Configuration;
NDIS_802_11_NETWORK_INFRASTRUCTURE InfrastructureMode;
NDIS_802_11_RATES SupportedRates;
// fields from NDIS_802_11_WEP structure
ULONG KeyIndex; // 0 is the per-client key, 1-N are the global keys
ULONG KeyLength; // length of key in bytes
UCHAR KeyMaterial[WZCCTL_MAX_WEPK_MATERIAL]; // variable length depending on above field
// aditional field for the Authentication mode
NDIS_802_11_AUTHENTICATION_MODE AuthenticationMode;
RAW_DATA rdUserData; // upper level buffer, attached to this config
#ifdef UNDER_CE
WZC_EAPOL_PARAMS EapolParams; // 802.1x parameters
#endif
RAW_DATA rdNetworkData; // upper level buffer, attached to this config
ULONG WPAMCastCipher; // Multicast Cipher Suite for WPA.
ULONG ulMediaType; //
} WZC_WLAN_CONFIG, *PWZC_WLAN_CONFIG;
//---------------------------------------
// [P]WZC_802_11_CONFIG_LIST: like NDIS_802_11_BSSID_LIST but indexes a
// set of [Preferred] Wireless Zero Configurations
typedef struct
{
ULONG NumberOfItems; // number of elements in the array below
ULONG Index; // [start] index in the array below
WZC_WLAN_CONFIG Config[1]; // array of WZC_WLAN_CONFIGs
} WZC_802_11_CONFIG_LIST, *PWZC_802_11_CONFIG_LIST;
// WZC dialog codes have the 16th bit set to 1. This is what quickly sepparates them from EAPOL signals.
#define WZCDLG_IS_WZC(x) (((x) & 0x00010000) == 0x00010000)
#define WZCDLG_FAILED 0x00010001 // 802.11 automatic configuration failed
// Dialog BLOB passed through the UI pipe to netman and wzcdlg
typedef struct _WZCDLG_DATA
{
DWORD dwCode;
DWORD lParam; // long numeric data
} WZCDLG_DATA, *PWZCDLG_DATA;
#endif
//---------------------------------------
// [P]INTF_ENTRY: describes the key info for one interface
// this is used in conjunction with [P]INTFS_KEY_TABLE and WZCEnumInterfaces
typedef struct
{
#if defined(MIDL_PASS)
[unique, string] LPWSTR wszGuid;
#else
LPWSTR wszGuid;
#endif
} INTF_KEY_ENTRY, *PINTF_KEY_ENTRY;
//---------------------------------------
// [P]INTFS_KEY_TABLE: describes the table of key info for all interfaces
// this is used in conjunction with [P]INTF_KEY_ENTRY and WZCEnumInterfaces
typedef struct
{
DWORD dwNumIntfs;
#if defined(MIDL_PASS)
[size_is(dwNumIntfs)] PINTF_KEY_ENTRY pIntfs;
#else
PINTF_KEY_ENTRY pIntfs;
#endif
} INTFS_KEY_TABLE, *PINTFS_KEY_TABLE;
//---------------------------------------
// Bits used in conjunction with INTF_ENTRY, WZCQueryInterface
// and WZCSetInterface. They point to the relevant information
// that is requested from the service or to the relevant information
// to be set down to the interface. On the output, they point to
// the information that was processed (queried/set) successfully.
#define INTF_ALL 0xffffffff
#define INTF_ALL_FLAGS 0x0000ffff
#define INTF_CM_MASK 0x00000007 // mask for the configuration mode (NDIS_802_11_NETWORK_INFRASTRUCTURE value)
#define INTF_ENABLED 0x00008000 // zero conf enabled for this interface
#define INTF_FALLBACK 0x00004000 // attempt to connect to visible non-preferred networks also
#define INTF_OIDSSUPP 0x00002000 // 802.11 OIDs are supported by the driver/firmware (can't be set)
#define INTF_VOLATILE 0x00001000 // the service parameters are volatile.
#define INTF_POLICY 0x00000800 // the service parameters are enforced by the policy.
#define INTF_DESCR 0x00010000
#define INTF_NDISMEDIA 0x00020000
#define INTF_PREFLIST 0x00040000
#define INTF_CAPABILITIES 0x00080000
#define INTF_ALL_OIDS 0xfff00000
#define INTF_HANDLE 0x00100000
#define INTF_INFRAMODE 0x00200000
#define INTF_AUTHMODE 0x00400000
#define INTF_WEPSTATUS 0x00800000
#define INTF_SSID 0x01000000
#define INTF_BSSID 0x02000000
#define INTF_BSSIDLIST 0x04000000
#define INTF_LIST_SCAN 0x08000000
#define INTF_ADDWEPKEY 0x10000000
#define INTF_REMWEPKEY 0x20000000
#define INTF_LDDEFWKEY 0x40000000 // reload the default WEP_KEY
//---------------------------------------
// Bits used to specify particular control options for the interface
// entry
#define INTFCTL_CM_MASK 0x0007 // mask for the configuration mode (NDIS_802_11_NETWORK_INFRASTRUCTURE value)
#define INTFCTL_ENABLED 0x8000 // zero conf enabled for this interface
#define INTFCTL_FALLBACK 0x4000 // attempt to connect to visible non-preferred networks also
#define INTFCTL_OIDSSUPP 0x2000 // 802.11 OIDs are supported by the driver/firmware (can't be set)
#define INTFCTL_VOLATILE 0x1000 // the service parameters are volatile.
#define INTFCTL_POLICY 0x0800 // the service parameters policy enforced.
#ifdef UNDER_CE
#define INTFCTL_8021XSUPP 0x1000 // 802.1x support enabled
#endif
//---------------------------------------
// Bits used to specify various capabilities of the interface
#define INTFCAP_MAX_CIPHER_MASK 0x000000ff
#define INTFCAP_SSN 0x00000100
//---------------------------------------
// [P]INTF_ENTRY: contains everything an RPC client needs to know
// about an interface. It is used in conjunction with RpcQueryInterface.
// Flags below are to be used to specify what info is queried for the
// interface. Guid field is not covered since this is the key of the
// structure so it has to be specified eather way.
typedef struct
{
#if defined(MIDL_PASS)
[string] LPWSTR wszGuid;
#else
LPWSTR wszGuid;
#endif
#if defined(MIDL_PASS)
[string] LPWSTR wszDescr;
#else
LPWSTR wszDescr;
#endif
ULONG ulMediaState;
ULONG ulMediaType;
ULONG ulPhysicalMediaType;
INT nInfraMode;
INT nAuthMode;
INT nWepStatus;
DWORD dwCtlFlags; // control flags (see INTFCTL_* defines)
DWORD dwCapabilities; // capabilities flags (see INTFCAP_* defines)
RAW_DATA rdSSID; // encapsulates the SSID raw binary
RAW_DATA rdBSSID; // encapsulates the BSSID raw binary
RAW_DATA rdBSSIDList; // encapsulates one WZC_802_11_CONFIG_LIST structure
RAW_DATA rdStSSIDList; // encapsulates one WZC_802_11_CONFIG_LIST structure
RAW_DATA rdCtrlData; // data for various control actions on the interface
#ifdef UNDER_CE
BOOL bInitialized; // To track caller that freeing
// the same structure more than one time..
#endif
DWORD nWPAMCastCipher;
} INTF_ENTRY, *PINTF_ENTRY;
//---------------------------------------
// Defines and datastucture for handling the WZC Service Context (generic service params)
// Default values for WZC internal timers (WZC_CONTEXT.tmT* fields)
#ifdef UNDER_CE
#define TMMS_INFINITE 0x70000000
#define TMMS_DEFAULT_TR 0x00000bb8 // Timeout until a rescan completes: ms (3sec)
#define TMMS_DEFAULT_TC TMMS_INFINITE // Timeout to retry a valid configuration: ms (Don't rescan!)
#define TMMS_DEFAULT_TP 0x000007d0 // Timeout to expect a media connect for a selected config: ms (2sec)
#define TMMS_DEFAULT_TF 0x0000ea60 // Timeout to recover from a failed configuration: ms (1min)
#define TMMS_DEFAULT_TD 0x00001388 // Timeout to delay the {SSr} processing: ms (5sec)
#else // UNDER_CE
#define TMMS_DEFAULT_TR 0x00000bb8 // Timeout until a rescan completes: ms (3sec)
#define TMMS_DEFAULT_TC 0x0000ea60 // Timeout to retry a valid configuration: ms (1min)
#define TMMS_DEFAULT_TP 0x000007d0 // Timeout to expect a media connect for a selected config: ms (2sec)
#define TMMS_DEFAULT_TF 0x0000ea60 // Timeout to recover from a failed configuration: ms (1min)
#define TMMS_DEFAULT_TD 0x00001388 // Timeout to delay the {SSr} processing: ms (5sec)
#endif // UNDER_CE
// Default turns logging on
#define WZC_CTXT_LOGGING_ON 0x00000001
// Structure: WZC_CONTEXT holds all global service options that may be customized
typedef struct _wzc_context_t
{
#ifndef UNDER_CE
//
// This flag is not used in CE.
// Application calling WZCSetContext() should get the initial value using
// WZCQueryContext().
// Any entry set to 0xffffffff will automatically be replaced with default value hard
// coded in ZeroConfiguration (see TMMS_DEFAULT_XXX above).
//
DWORD dwFlags; //service flags (see WZC_CTXT_*)
#endif
//Service specific timers
DWORD tmTr; //Rescan timeout
DWORD tmTc; //Retry valid config timeout
DWORD tmTp; //Timeout to expect a media connect
DWORD tmTf; //Timeout to recover from an invalid config
DWORD tmTd; //Timeout to delay {Ssr} processing
} WZC_CONTEXT, *PWZC_CONTEXT;
// Context control flags (see WZCSet/QueryContext() calls)
#define WZC_CONTEXT_CTL_LOG 0x00000001
#define WZC_CONTEXT_CTL_TIMER_TR 0x00000002
#define WZC_CONTEXT_CTL_TIMER_TC 0x00000004
#define WZC_CONTEXT_CTL_TIMER_TP 0x00000008
#define WZC_CONTEXT_CTL_TIMER_TF 0x00000010
#define WZC_CONTEXT_CTL_TIMER_TD 0x00000020
//---------------------------------------
// Utility Rpc memory management routines
#define RpcCAlloc(nBytes) MIDL_user_allocate(nBytes)
#define RpcFree(pMem) MIDL_user_free(pMem)
//---------------------------------------
// GetSPResModule: Utility function used to return
// the handle to the module having WZC UI resources
// (needed for XP.QFE & XP.SP1 builds)
HINSTANCE
WZCGetSPResModule();
//---------------------------------------
// WZCDeleteIntfObj: cleans an INTF_ENTRY object that is
// allocated within any RPC call.
//
// Parameters
// pIntf
// [in] pointer to the INTF_ENTRY object to delete
VOID
WZCDeleteIntfObj(
PINTF_ENTRY pIntf);
//---------------------------------------
// WZCPassword2Key: Translates a user password (8 to 63 ascii chars)
// into a 256 bit network key)
VOID
WZCPassword2Key(
PWZC_WLAN_CONFIG pwzcConfig,
LPCSTR cszPassword);
//---------------------------------------
#ifdef UNDER_CE
//
// Only in CE..
// This function enumerates all the EAP extensions currently installed
// in the system..
//
//DWORD
//WZCEnumEapExtensions(
// DWORD *pdwNumOfExtensions,
// PEAP_EXTENSION_INFO *pEapExtensions);
#endif
//---------------------------------------
// WZCEnumInterfaces: provides the table of key
// information for all the interfaces that are managed.
// For all subsequent calls the clients need to identify
// the Interface it operates on by providing the respective
// key info.
//
// Parameters:
// pSrvAddr
// [in] WZC Server to contact
// pIntf
// [out] table of key info for all interfaces
// Returned value:
// Win32 error code
DWORD
WZCEnumInterfaces(
LPWSTR pSrvAddr,
PINTFS_KEY_TABLE pIntfs);
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -