VDS_ISCSI_SHARED_SECRET structure (vds.h)

[Beginning with Windows 8 and Windows Server 2012, the Virtual Disk Service COM interface is superseded by the Windows Storage Management API.]

Defines a CHAP shared secret.

Syntax

typedef struct _VDS_ISCSI_SHARED_SECRET {
  UCHAR *pSharedSecret;
  ULONG ulSharedSecretSize;
} VDS_ISCSI_SHARED_SECRET;

Members

pSharedSecret

A pointer to an array of bytes that contains the CHAP shared secret. If a shared secret is not necessary, this parameter should be NULL.

ulSharedSecretSize

The number of bytes in the array that the pSharedSecret member points to. If the pSharedSecret member is NULL, this parameter must be zero. If pSharedSecret is not NULL, this parameter must be greater than or equal to 12 and less than or equal to 16.

Remarks

This structure is used by the following methods:

• IVdsServiceIscsi::SetInitiatorSharedSecret sets the shared secret for an iSCSI initiator. If the pSharedSecret member is NULL and the ulSharedSecretSize member is zero, SetInitiatorSharedSecret clears any existing shared secrets.
• IVdsIscsiTarget::SetSharedSecret sets the shared secret for an iSCSI target. If the pSharedSecret member is NULL and the ulSharedSecretSize member is zero, SetSharedSecret clears any existing shared secrets.
• IVdsServiceIscsi::RememberTargetSharedSecret tells the initiator to remember the secret of the target.
• IVdsIscsiTarget::RememberInitiatorSharedSecret tells the target to remember the secret of the initiator.

For one-way CHAP, the secret is set on the target. The initiator must remember the CHAP secret of the target in order to do a successful login.

For mutual CHAP, secrets are set on the target and the initiator. To do a successful login, the target and the initiator must remember each other's secrets.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 R2 [desktop apps only]
Header	vds.h
Redistributable	VDS 1.1

See also

IVdsIscsiTarget::RememberInitiatorSharedSecret

IVdsIscsiTarget::SetSharedSecret

IVdsServiceIscsi::RememberTargetSharedSecret

IVdsServiceIscsi::SetInitiatorSharedSecret