Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

983 lines
21 KiB

//============================================================================
// Copyright (c) 1996, Microsoft Corporation
//
// File: setup.c
//
// History:
// 06/24/96 Abolade Gbadegesin Created.
//
// Implements API functions used by IP and IPX to read installation information
// stored under HKLM\Software\Microsoft\Router.
//
// The API functions are presented first, followed by private functions
// in alphabetical order.
//============================================================================
#include <nt.h>
#include <ntrtl.h>
#include <nturtl.h>
#include <windows.h>
#include <rtutils.h>
#include <mprapi.h>
//
// Constant strings used to access the registry:
//
extern const WCHAR c_szProtocolId[];
extern const WCHAR c_szRouter[];
extern const WCHAR c_szRouterManagers[];
const WCHAR c_szDLLName[] = L"DLLName";
const TCHAR c_szCurrentVersion[] = L"CurrentVersion";
const WCHAR c_szMicrosoft[] = L"Microsoft";
const WCHAR c_szSoftware[] = L"Software";
const WCHAR c_szIpInIp[] = L"IpInIp";
//
// Memory management macros:
//
#define Malloc(s) HeapAlloc(GetProcessHeap(), 0, (s))
#define ReAlloc(p,s) HeapReAlloc(GetProcessHeap(), 0, (p), (s))
#define Free(p) HeapFree(GetProcessHeap(), 0, (p))
#define Free0(p) ((p) ? Free(p) : TRUE)
DWORD
QueryRmSoftwareKey(
IN HKEY hkeyMachine,
IN DWORD dwTransportId,
OUT HKEY* phkrm,
OUT LPWSTR* lplpwsRm
);
DWORD
QueryIpInIpSoftwareKey(
IN HKEY hkeyMachine,
OUT HKEY* phkIpIpRead,
OUT HKEY* phkIpIpWrite,
OUT PDWORD pdwNumValues,
OUT PDWORD pdwMaxValueNameLen,
OUT PDWORD pdwMaxValueLen
);
//----------------------------------------------------------------------------
// Function: MprSetupProtocolEnum
//
// Enumerates the protocols installed for transport 'dwTransportId'.
//
// The information is loaded from HKLM\Software\Microsoft\Router,
// where subkeys exist for each router-manager under the 'RouterManagers' key.
// Each router-manager subkey has subkeys containing information
// about that router-manager's routing-protocols.
//
// This API reads a subset of that information, so that router-managers
// can map protocol-IDs to DLL names when loading routing-protocols.
//----------------------------------------------------------------------------
DWORD APIENTRY
MprSetupProtocolEnum(
IN DWORD dwTransportId,
OUT LPBYTE* lplpBuffer, // MPR_PROTOCOL_0
OUT LPDWORD lpdwEntriesRead
) {
HKEY hkrm;
WCHAR* lpwsRm = NULL;
DWORD dwErr, dwItemCount;
MPR_PROTOCOL_0* pItem, *pItemTable = NULL;
//
// Validate the caller's parameters
//
if (!lplpBuffer ||
!lpdwEntriesRead) { return ERROR_INVALID_PARAMETER; }
*lplpBuffer = NULL;
*lpdwEntriesRead = 0;
//
// Open the key for the specified router-manager
// under HKLM\Software\Microsoft\Router\CurrentVersion\RouterManagers
//
dwErr = QueryRmSoftwareKey(
HKEY_LOCAL_MACHINE, dwTransportId, &hkrm, &lpwsRm
);
if (dwErr != NO_ERROR) { return dwErr; }
//
// The transport was found, so its registry key is in 'hkrm'
//
do {
//
// Retrieve information about the subkeys of the router-manager,
// since these should all contain data for routing-protocols.
//
WCHAR* pwsKey;
DWORD i, dwSize, dwType;
DWORD dwKeyCount, dwMaxKeyLength;
dwErr = RegQueryInfoKey(
hkrm, NULL, NULL, NULL, &dwKeyCount, &dwMaxKeyLength,
NULL, NULL, NULL, NULL, NULL, NULL
);
if (dwErr != ERROR_SUCCESS) { break; }
//
// Allocate enough space for the longest of the subkeys
//
pwsKey = Malloc((dwMaxKeyLength + 1) * sizeof(WCHAR));
if (!pwsKey) { dwErr = ERROR_NOT_ENOUGH_MEMORY; break; }
//
// Allocate an array to hold the keys' contents
//
pItemTable = (MPR_PROTOCOL_0*)Malloc(dwKeyCount * sizeof(*pItem));
if (!pItemTable) { dwErr = ERROR_NOT_ENOUGH_MEMORY; break; }
ZeroMemory(pItemTable, dwKeyCount * sizeof(*pItem));
//
// Enumerate the keys
//
dwItemCount = 0;
for (i = 0; i < dwKeyCount; i++) {
HKEY hkprot;
PBYTE pValue = NULL;
//
// Get the name of the current key
//
dwSize = dwMaxKeyLength + 1;
dwErr = RegEnumKeyEx(
hkrm, i, pwsKey, &dwSize, NULL, NULL, NULL, NULL
);
if (dwErr != ERROR_SUCCESS) { continue; }
//
// Open the key
//
dwErr = RegOpenKeyEx(hkrm, pwsKey, 0, KEY_READ, &hkprot);
if (dwErr != ERROR_SUCCESS) { continue; }
pItem = pItemTable + dwItemCount;
do {
DWORD dwMaxValLength;
//
// Copy the string for the protocol
//
lstrcpyn(pItem->wszProtocol, pwsKey, MAX_PROTOCOL_NAME_LEN+1);
//
// Get information about the key's values
//
dwErr = RegQueryInfoKey(
hkprot, NULL, NULL, NULL, NULL, NULL, NULL, NULL,
NULL, &dwMaxValLength, NULL, NULL
);
if (dwErr != ERROR_SUCCESS) { break; }
//
// Allocate space to hold the longest of the values
//
pValue = Malloc(dwMaxValLength + 1);
if (!pValue) { dwErr = ERROR_NOT_ENOUGH_MEMORY; break; }
//
// Read the ProtocolId value
//
dwSize = dwMaxValLength + 1;
dwErr = RegQueryValueEx(
hkprot, c_szProtocolId, 0, &dwType, pValue, &dwSize
);
if (dwErr != ERROR_SUCCESS) { break; }
pItem->dwProtocolId = *(PDWORD)pValue;
//
// Read the DLLName value
//
dwSize = dwMaxValLength + 1;
dwErr = RegQueryValueEx(
hkprot, c_szDLLName, 0, &dwType, pValue, &dwSize
);
if (dwErr != ERROR_SUCCESS) { break; }
lstrcpyn(
pItem->wszDLLName, (WCHAR*)pValue, MAX_PROTOCOL_DLL_LEN+1);
//
// Increment the count of loaded protocols
//
++dwItemCount;
dwErr = ERROR_SUCCESS;
} while(FALSE);
Free0(pValue);
RegCloseKey(hkprot);
}
Free0(pwsKey);
} while(FALSE);
Free0(lpwsRm);
if (dwErr != NO_ERROR) {
Free0(pItemTable);
}
else {
//
// Adjust the size of the buffer to be returned,
// in case not all the keys contained routing-protocols,
// and save the number of protocols loaded.
//
*lplpBuffer = ReAlloc(pItemTable, dwItemCount * sizeof(*pItem));
*lpdwEntriesRead = dwItemCount;
}
RegCloseKey(hkrm);
return dwErr;
}
//----------------------------------------------------------------------------
// Function: MprSetupProtocolFree
//
// Called to free a buffer allocated by 'MprSetupProtocolEnum'.
//----------------------------------------------------------------------------
DWORD APIENTRY
MprSetupProtocolFree(
IN LPVOID lpBuffer
) {
if (!lpBuffer) { return ERROR_INVALID_PARAMETER; }
Free(lpBuffer);
return NO_ERROR;
}
DWORD
APIENTRY
MprSetupIpInIpInterfaceFriendlyNameEnum(
IN PWCHAR pwszMachineName,
OUT LPBYTE* lplpBuffer, // MPR_IPINIP_INTERFACE_0
OUT LPDWORD lpdwEntriesRead
)
{
HKEY hkRead=NULL, hkWrite=NULL, hkMachine=NULL;
DWORD dwErr, dwIndex, i;
DWORD dwNumValues, dwMaxValueNameLen, dwMaxValueLen;
PMPR_IPINIP_INTERFACE_0 pItem, pTable = NULL;
//
// Validate the caller's parameters
//
if (!lplpBuffer ||
!lpdwEntriesRead) {
return ERROR_INVALID_PARAMETER;
}
*lplpBuffer = NULL;
*lpdwEntriesRead = 0;
//
// Connect to the registry
//
dwErr = RegConnectRegistry(
pwszMachineName,
HKEY_LOCAL_MACHINE,
&hkMachine
);
if(dwErr != NO_ERROR) {
return dwErr;
}
//
// Open the HKLM\Software\Microsoft\IpInIp key
//
dwErr = QueryIpInIpSoftwareKey(
hkMachine,
&hkRead,
&hkWrite,
&dwNumValues,
&dwMaxValueNameLen,
&dwMaxValueLen
);
if (dwErr != NO_ERROR)
{
//We need to close hkMachine here
RegCloseKey(hkMachine);
return dwErr;
}
if(dwNumValues == 0) {
if(hkWrite != NULL) {
RegCloseKey(hkWrite);
}
RegCloseKey(hkRead);
RegCloseKey(hkMachine);
return NO_ERROR;
}
//
// So the Value Name shouldnt be longer than a GUID length and
// the value itself should be less that MAX_INTERFACE_NAME_LEN
//
if((dwMaxValueNameLen > 38) ||
(dwMaxValueLen > MAX_INTERFACE_NAME_LEN)) {
RegCloseKey(hkMachine);
return ERROR_REGISTRY_CORRUPT;
}
dwErr = NO_ERROR;
do {
UNICODE_STRING usTempString;
WCHAR rgwcGuid[40];
DWORD dwType;
//
// Allocate an array to hold the ipinip info
//
pTable = Malloc(dwNumValues * sizeof(*pItem));
if (!pTable) { dwErr = ERROR_NOT_ENOUGH_MEMORY; break; }
ZeroMemory(pTable, dwNumValues * sizeof(*pItem));
//
// Enumerate the keys
//
usTempString.MaximumLength = sizeof(rgwcGuid);
usTempString.Buffer = rgwcGuid;
for (i = 0, dwIndex = 0; i < dwNumValues; i++) {
DWORD dwValueNameLen = 39;
DWORD dwValueLen = (MAX_INTERFACE_NAME_LEN + 1) * sizeof(WCHAR);
dwErr = RegEnumValue(
hkRead,
i,
rgwcGuid,
&dwValueNameLen,
NULL,
&dwType,
(PBYTE)(pTable[dwIndex].wszFriendlyName),
&dwValueLen
);
if((dwErr == NO_ERROR) &&
(dwType == REG_SZ)) {
//
// Convert the string to a guid
//
ASSERT(dwValueNameLen <= 38);
usTempString.Length = (USHORT)(dwValueNameLen * sizeof(WCHAR));
dwErr = RtlGUIDFromString(
&usTempString,
&(pTable[dwIndex].Guid)
);
if(dwErr == STATUS_SUCCESS) {
dwIndex++;
}
}
}
} while(FALSE);
if (dwIndex == 0) {
Free0(pTable);
} else {
*lplpBuffer = (PBYTE)pTable;
*lpdwEntriesRead = dwIndex;
}
if(hkWrite != NULL) {
RegCloseKey(hkWrite);
}
RegCloseKey(hkRead);
RegCloseKey(hkMachine);
if(dwIndex == 0) {
return dwErr ? dwErr : ERROR_CAN_NOT_COMPLETE;
}
return NO_ERROR;
}
DWORD
APIENTRY
MprSetupIpInIpInterfaceFriendlyNameFree(
IN LPVOID lpBuffer
)
{
if (!lpBuffer) { return ERROR_INVALID_PARAMETER; }
Free(lpBuffer);
return NO_ERROR;
}
DWORD
APIENTRY
MprSetupIpInIpInterfaceFriendlyNameCreate(
PWCHAR pwszMachineName,
PMPR_IPINIP_INTERFACE_0 pNameInformation
)
{
DWORD dwErr, dwNumValues, dwMaxValueNameLen, dwMaxValueLen;
DWORD dwType, dwValueLen;
HKEY hkMachine=NULL, hkRead=NULL, hkWrite=NULL;
WCHAR rgwcName[MAX_INTERFACE_NAME_LEN + 2];
UNICODE_STRING usTempString;
//
// Connect to the registry
//
dwErr = RegConnectRegistry(
pwszMachineName,
HKEY_LOCAL_MACHINE,
&hkMachine);
if(dwErr != NO_ERROR) {
return dwErr;
}
//
// Just call the query function to open the key
//
dwErr = QueryIpInIpSoftwareKey(
hkMachine,
&hkRead,
&hkWrite,
&dwNumValues,
&dwMaxValueNameLen,
&dwMaxValueLen
);
RegCloseKey(hkMachine);
if (dwErr != NO_ERROR) {
return dwErr;
}
//
// Dont need this
//
RegCloseKey(hkRead);
if(hkWrite == NULL) {
return ERROR_ACCESS_DENIED;
}
//
// Convert guid to string
//
dwErr = RtlStringFromGUID(
&(pNameInformation->Guid),
&usTempString);
if(dwErr != STATUS_SUCCESS) {
RegCloseKey(hkWrite);
return ERROR_INVALID_PARAMETER;
}
//
// See if it exists
//
dwValueLen = sizeof(rgwcName);
dwErr = RegQueryValueEx(
hkWrite,
usTempString.Buffer,
NULL,
&dwType,
(PBYTE)rgwcName,
&dwValueLen);
if(dwErr == NO_ERROR) {
//
// hmm already exists
//
RegCloseKey(hkWrite);
RtlFreeUnicodeString(&usTempString);
return ERROR_OBJECT_ALREADY_EXISTS;
}
//
// Set the value
//
dwErr = RegSetValueEx(
hkWrite,
usTempString.Buffer,
0,
REG_SZ,
(PBYTE)pNameInformation->wszFriendlyName,
(wcslen(pNameInformation->wszFriendlyName) + 1) * sizeof(WCHAR));
RegCloseKey(hkWrite);
RtlFreeUnicodeString(&usTempString);
return dwErr;
}
DWORD
APIENTRY
MprSetupIpInIpInterfaceFriendlyNameDelete(
IN PWCHAR pwszMachineName,
IN GUID *pGuid
)
{
DWORD dwErr, dwNumValues, dwMaxValueNameLen, dwMaxValueLen;
HKEY hkMachine=NULL, hkRead=NULL, hkWrite=NULL;
UNICODE_STRING usTempString;
//
// Connect to the registry
//
dwErr = RegConnectRegistry(
pwszMachineName,
HKEY_LOCAL_MACHINE,
&hkMachine);
if(dwErr != NO_ERROR) {
return dwErr;
}
//
// Just call the query function to open the key
//
dwErr = QueryIpInIpSoftwareKey(
hkMachine,
&hkRead,
&hkWrite,
&dwNumValues,
&dwMaxValueNameLen,
&dwMaxValueLen
);
RegCloseKey(hkMachine);
if (dwErr != NO_ERROR) {
return dwErr;
}
//
// Dont need this
//
RegCloseKey(hkRead);
if(hkWrite == NULL) {
return ERROR_ACCESS_DENIED;
}
//
// Convert guid to string
//
dwErr = RtlStringFromGUID(
pGuid,
&usTempString);
if(dwErr != STATUS_SUCCESS) {
RegCloseKey(hkWrite);
return ERROR_INVALID_PARAMETER;
}
//
// See if it exists
//
dwErr = RegDeleteValue(
hkWrite,
usTempString.Buffer);
RegCloseKey(hkWrite);
RtlFreeUnicodeString(&usTempString);
return dwErr;
}
//----------------------------------------------------------------------------
// Function: QueryRmSoftwareKey
//
// Called to open the key for a router-manager given its transport ID.
//----------------------------------------------------------------------------
DWORD
QueryRmSoftwareKey(
IN HKEY hkeyMachine,
IN DWORD dwTransportId,
OUT HKEY* phkrm,
OUT LPWSTR* lplpwsRm
) {
HKEY hkey;
DWORD dwErr;
WCHAR wszKey[256], *pwsKey;
//
// Open the key HKLM\Software\Microsoft\Router\RouterManagers
//
wsprintf(
wszKey, L"%s\\%s\\%s\\%s\\%s", c_szSoftware, c_szMicrosoft, c_szRouter,
c_szCurrentVersion, c_szRouterManagers
);
dwErr = RegOpenKeyEx(hkeyMachine, wszKey, 0, KEY_READ, &hkey);
if (dwErr != ERROR_SUCCESS) { return dwErr; }
//
// Enumerate the subkeys of the 'RouterManagers' key,
// in search of one which as a 'ProtocolId' value equal to 'dwTransportId'.
//
do {
//
// Retrieve information about the subkeys of the key
//
DWORD dwKeyCount, dwMaxKeyLength;
DWORD i, dwSize, dwType, dwProtocolId = ~dwTransportId;
dwErr = RegQueryInfoKey(
hkey, NULL, NULL, NULL, &dwKeyCount, &dwMaxKeyLength,
NULL, NULL, NULL, NULL, NULL, NULL
);
if (dwErr != ERROR_SUCCESS) { break; }
//
// Allocate enough space for the longest of the subkeys
//
pwsKey = Malloc((dwMaxKeyLength + 1) * sizeof(WCHAR));
if (!pwsKey) { dwErr = ERROR_NOT_ENOUGH_MEMORY; break; }
//
// Enumerate the keys
//
for (i = 0; i < dwKeyCount; i++) {
//
// Get the name of the current key
//
dwSize = dwMaxKeyLength + 1;
dwErr = RegEnumKeyEx(
hkey, i, pwsKey, &dwSize, NULL, NULL, NULL, NULL
);
if (dwErr != ERROR_SUCCESS) { continue; }
//
// Open the key
//
dwErr = RegOpenKeyEx(hkey, pwsKey, 0, KEY_READ, phkrm);
if (dwErr != ERROR_SUCCESS) { continue; }
//
// Try to read the ProtocolId value
//
dwSize = sizeof(dwProtocolId);
dwErr = RegQueryValueEx(
*phkrm, c_szProtocolId, 0, &dwType,
(BYTE*)&dwProtocolId, &dwSize
);
//
// Break if this is the transport we're looking for,
// otherwise close the key and continue
//
if (dwErr == ERROR_SUCCESS &&
dwProtocolId == dwTransportId) { break; }
RegCloseKey(*phkrm);
}
if (i >= dwKeyCount) { Free(pwsKey); break; }
//
// The transport was found, so save its key-name
//
*lplpwsRm = pwsKey;
} while(FALSE);
RegCloseKey(hkey);
return (*lplpwsRm ? NO_ERROR : ERROR_NO_MORE_ITEMS);
}
DWORD
QueryIpInIpSoftwareKey(
IN HKEY hkeyMachine,
OUT HKEY* phkIpIpRead,
OUT HKEY* phkIpIpWrite,
OUT PDWORD pdwNumValues,
OUT PDWORD pdwMaxValueNameLen,
OUT PDWORD pdwMaxValueLen
)
{
HKEY hkReg;
DWORD dwErr, dwDisp;
WCHAR wszKey[256], *pwsKey;
DWORD dwNumValues, dwMaxValueNameLen, dwMaxValueLen;
*phkIpIpWrite = NULL;
*phkIpIpRead = NULL;
*pdwNumValues = 0;
*pdwMaxValueLen = 0;
*pdwMaxValueNameLen = 0;
//
// Open the key HKLM\Software\Microsoft\IpInIp
//
wsprintf(
wszKey, L"%s\\%s\\%s", c_szSoftware, c_szMicrosoft, c_szIpInIp
);
//
// First open/create a key for all access
//
dwErr = RegCreateKeyEx(
hkeyMachine,
wszKey,
0,
NULL,
0,
KEY_ALL_ACCESS,
NULL,
&hkReg,
&dwDisp);
if (dwErr == NO_ERROR) {
*phkIpIpWrite = hkReg;
} else {
*phkIpIpWrite = NULL;
}
dwErr = RegOpenKeyEx(
hkeyMachine,
wszKey,
0,
KEY_READ,
&hkReg);
if (dwErr != NO_ERROR) {
ASSERT(*phkIpIpWrite == NULL);
*phkIpIpRead = NULL;
return dwErr;
} else {
*phkIpIpRead = hkReg;
}
//
// Atleast the read key is opened, query the number of interfaces
//
dwErr = RegQueryInfoKey(
*phkIpIpRead,
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,
&dwNumValues,
&dwMaxValueNameLen,
&dwMaxValueLen,
NULL,
NULL);
if (dwErr != NO_ERROR) {
if(*phkIpIpWrite != NULL) {
RegCloseKey(*phkIpIpWrite);
}
RegCloseKey(*phkIpIpRead);
return dwErr;
}
*pdwNumValues = dwNumValues;
*pdwMaxValueLen = dwMaxValueLen;
*pdwMaxValueNameLen = dwMaxValueNameLen;
return NO_ERROR;
}