org.cipango.diameter.ims
Class Zh

java.lang.Object
  org.cipango.diameter.ims.Zh

public class Zh
extends java.lang.Object

Zh and Zn is defined in

• 3GPP TS 29109: Generic Authentication Architecture (GAA); Zh and Zn Interfaces based on the Diameter protocol;

See Also:

TS 29.109

Nested Class Summary

static class	Zh.GbaType
static class	Zh.GbaUAwarenessIndicator
static class	Zh.PrivateIdentityRequest
static class	Zh.UeIdType
static class	Zh.UiccMe

Field Summary

static DiameterCommand	BIA < Boostrapping-Info-Answer > ::= < Diameter Header: 310, PXY, 16777220 > < Session-Id > { Vendor-Specific-Application-Id } [ Result-Code ] [ Experimental-Result] { Origin-Host } ; Address of BSF { Origin-Realm } ; Realm of BSF [ User-Name ] ; IMPI [ ME-Key-Material ] ; Required [ UICC-Key-Material ] ; Conditional [ Key-ExpiryTime ] ; Time of expiry [ BootstrapInfoCreationTime ] ; Bootstrapinfo creation time [ GBA-UserSecSettings ] ; Selected USSs [ GBA-Type ] ; GBA type used in bootstrapping *[ AVP ] *[ Proxy-Info ] *[ Route-Record ]
static int	BIA_ORDINAL
static DiameterCommand	BIR < Bootstrapping-Info-Request > ::=< Diameter Header: 310, REQ, PXY, 16777220 > < Session-Id > { Vendor-Specific-Application-Id } { Origin-Host } ; Address of NAF { Origin-Realm } ; Realm of NAF { Destination-Realm } ; Realm of BSF [ Destination-Host ] ; Address of the BSF * [ GAA-Service-Identifier ] ; Service identifiers { Transaction-Identifier } ; B-TID { NAF-Id } ; NAF_ID [ GBA_U-Awareness-Indicator ] ; GBA_U awareness of the NAF *[ AVP ] *[ Proxy-Info ] *[ Route-Record ]
static int	BIR_ORDINAL
static Type<java.util.Date>	BOOTSTRAP_INFO_CREATION_TIME The BootstrapInfoCreationTime AVP (AVP code 408) is of type Time.
static int	BOOTSTRAP_INFO_CREATION_TIME_ORDINAL
static ResultCode	DIAMETER_ERROR_IDENTITY_UNKNOWN A message was received by the HSS for an IMPI or IMPU that is unknown.
static int	DIAMETER_ERROR_IDENTITY_UNKNOWN_ORDINAL
static ResultCode	DIAMETER_ERROR_NOT_AUTHORIZED A message was received by the BSF which the BSF can not authorize.
static int	DIAMETER_ERROR_NOT_AUTHORIZED_ORDINAL
static ResultCode	DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID A message was received by the BSF for an invalid (e.g. unknown or expired) Bootstrapping Transaction Identifier (B-TID).
static int	DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID_ORDINAL
static Type<java.lang.String>	GAA_SERVICE_IDENTIFIER The GAA-Service-identifier AVP (AVP code 403) is of type OctedString.
static int	GAA_SERVICE_IDENTIFIER_ORDINAL
static Type<java.lang.String>	GBA_PUSH_INFO The GBA-Push-Info AVP (AVP code 417) is of type OctetString.
static int	GBA_PUSH_INFO_ORDINAL
static Type<Zh.GbaType>	GBA_TYPE The GBA-Type AVP (AVP code 410) is of type Enumerated.
static int	GBA_TYPE_ORDINAL
static Type<Zh.GbaUAwarenessIndicator>	GBA_U_AWARENESS_INDICATOR The conditional GBA_U-Awareness-Indicator AVP (AVP code 407) is of type Enumerated.
static int	GBA_U_AWARENESS_INDICATOR_ORDINAL
static Type<java.lang.String>	GBA_USER_SEC_SETTINGS The GAA-UserSecSettings AVP (AVP code 400) is of type OctetString.
static int	GBA_USER_SEC_SETTINGS_ORDINAL
static Type<java.util.Date>	GUSS_TIMESTAMP The GUSS-Timestamp AVP (AVP code 409) is of type Time.
static int	GUSS_TIMESTAMP_ORDINAL
static Type<java.util.Date>	KEY_EXPIRY_TIME The Key-ExpiryTime AVP (AVP code 404) is of type Time.
static int	KEY_EXPIRY_TIME_ORDINAL
static Type<java.lang.String>	ME_KEY_MATERIAL The required ME-Key-Material AVP (AVP code 405) is of type OctetString.
static int	ME_KEY_MATERIAL_ORDINAL
static Type<java.lang.String>	NAF_ID The NAF-Id AVP (AVP code 402) is of type OctetString.
static int	NAF_ID_ORDINAL
static Type<java.lang.String>	NAF_SA_IDENTIFIER The NAF-SA-Identifier AVP (AVP code 418) is of type OctetString.
static int	NAF_SA_IDENTIFIER_ORDINAL
static Type<Zh.PrivateIdentityRequest>	PRIVATE_IDENTITY_REQUEST The Private-Identity-Request AVP (AVP code 416) is of type Enumerated.
static int	PRIVATE_IDENTITY_REQUEST_ORDINAL
static Type<java.util.Date>	REQUESTED_KEY_LIFETIME The Requested-Key-Lifetime AVP (AVP code 415) is of type Time.
static int	REQUESTED_KEY_LIFETIME_ORDINAL
static Type<java.lang.String>	TRANSACTION_IDENTIFIER The Transaction-Identifier AVP (AVP code 401) is of type OctetString.
static int	TRANSACTION_IDENTIFIER_ORDINAL
static Type<java.lang.String>	UE_ID The UE-Id AVP (AVP code 411) is of type OctedString.
static int	UE_ID_ORDINAL
static Type<Zh.UeIdType>	UE_ID_TYPE The UE-Id-Type AVP (AVP code 412) is of type Enumerated.
static int	UE_ID_TYPE_ORDINAL
static Type<java.lang.String>	UICC_APP_LABEL The UICC-App-Label AVP (AVP code 413) is of type OctedString.
static int	UICC_APP_LABEL_ORDINAL
static Type<java.lang.String>	UICC_KEY_MATERIAL The condition UICC-Key-Material AVP (AVP code 406) is of type OctetString.
static int	UICC_KEY_MATERIAL_ORDINAL
static Type<Zh.UiccMe>	UICC_ME The UICC-ME AVP (AVP code 414) is of type Enumerated.
static int	UICC_ME_ORDINAL
static int	ZH_APPLICATION
static ApplicationId	ZH_APPLICATION_ID
static int	ZN_APPLICATION
static ApplicationId	ZN_APPLICATION_ID

Constructor Summary

Zh()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ZH_APPLICATION

public static final int ZH_APPLICATION

See Also:

Constant Field Values

ZN_APPLICATION

public static final int ZN_APPLICATION

See Also:

Constant Field Values

ZH_APPLICATION_ID

public static final ApplicationId ZH_APPLICATION_ID

ZN_APPLICATION_ID

public static final ApplicationId ZN_APPLICATION_ID

BIR_ORDINAL

public static final int BIR_ORDINAL

See Also:

Constant Field Values

BIA_ORDINAL

public static final int BIA_ORDINAL

See Also:

Constant Field Values

BIR

public static final DiameterCommand BIR

 < Bootstrapping-Info-Request > ::=< Diameter Header: 310, REQ, PXY, 16777220 >
    < Session-Id >
    { Vendor-Specific-Application-Id }
    { Origin-Host }     ; Address of NAF
    { Origin-Realm }    ; Realm of NAF
    { Destination-Realm }       ; Realm of BSF
    [ Destination-Host ]        ; Address of the BSF 
   * [ GAA-Service-Identifier ] ; Service identifiers
    { Transaction-Identifier }  ; B-TID
    { NAF-Id }  ; NAF_ID
    [ GBA_U-Awareness-Indicator ]       ; GBA_U awareness of the NAF
   *[ AVP ]
   *[ Proxy-Info ]
   *[ Route-Record ]
 

BIA

public static final DiameterCommand BIA

 < Boostrapping-Info-Answer > ::= < Diameter Header: 310, PXY, 16777220 >
    < Session-Id >
    { Vendor-Specific-Application-Id }
    [ Result-Code ]     
    [ Experimental-Result]
    { Origin-Host }     ; Address of BSF
    { Origin-Realm }    ; Realm of BSF
    [ User-Name ]       ; IMPI
    [ ME-Key-Material ] ; Required
    [ UICC-Key-Material ]       ; Conditional
    [ Key-ExpiryTime ]  ; Time of expiry
    [ BootstrapInfoCreationTime ]       ; Bootstrapinfo creation time
    [ GBA-UserSecSettings ]     ; Selected USSs
    [ GBA-Type ]        ; GBA type used in bootstrapping
   *[ AVP ]
   *[ Proxy-Info ]
   *[ Route-Record ]
 

DIAMETER_ERROR_IDENTITY_UNKNOWN_ORDINAL

public static final int DIAMETER_ERROR_IDENTITY_UNKNOWN_ORDINAL

See Also:

Constant Field Values

DIAMETER_ERROR_NOT_AUTHORIZED_ORDINAL

public static final int DIAMETER_ERROR_NOT_AUTHORIZED_ORDINAL

See Also:

Constant Field Values

DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID_ORDINAL

public static final int DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID_ORDINAL

See Also:

Constant Field Values

DIAMETER_ERROR_IDENTITY_UNKNOWN

public static final ResultCode DIAMETER_ERROR_IDENTITY_UNKNOWN

A message was received by the HSS for an IMPI or IMPU that is unknown.

DIAMETER_ERROR_NOT_AUTHORIZED

public static final ResultCode DIAMETER_ERROR_NOT_AUTHORIZED

A message was received by the BSF which the BSF can not authorize. In this case the NAF should indicate to the UE that the service is not allowed. In case of GBA push, the NAF should not contact the UE.

DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID

public static final ResultCode DIAMETER_ERROR_TRANSACTION_IDENTIFIER_INVALID

A message was received by the BSF for an invalid (e.g. unknown or expired) Bootstrapping Transaction Identifier (B-TID). In this case the NAF should request the UE to bootstrap again.

GBA_USER_SEC_SETTINGS_ORDINAL

public static final int GBA_USER_SEC_SETTINGS_ORDINAL

See Also:

Constant Field Values

TRANSACTION_IDENTIFIER_ORDINAL

public static final int TRANSACTION_IDENTIFIER_ORDINAL

See Also:

Constant Field Values

NAF_ID_ORDINAL

public static final int NAF_ID_ORDINAL

See Also:

Constant Field Values

GAA_SERVICE_IDENTIFIER_ORDINAL

public static final int GAA_SERVICE_IDENTIFIER_ORDINAL

See Also:

Constant Field Values

KEY_EXPIRY_TIME_ORDINAL

public static final int KEY_EXPIRY_TIME_ORDINAL

See Also:

Constant Field Values

ME_KEY_MATERIAL_ORDINAL

public static final int ME_KEY_MATERIAL_ORDINAL

See Also:

Constant Field Values

UICC_KEY_MATERIAL_ORDINAL

public static final int UICC_KEY_MATERIAL_ORDINAL

See Also:

Constant Field Values

GBA_U_AWARENESS_INDICATOR_ORDINAL

public static final int GBA_U_AWARENESS_INDICATOR_ORDINAL

See Also:

Constant Field Values

BOOTSTRAP_INFO_CREATION_TIME_ORDINAL

public static final int BOOTSTRAP_INFO_CREATION_TIME_ORDINAL

See Also:

Constant Field Values

GUSS_TIMESTAMP_ORDINAL

public static final int GUSS_TIMESTAMP_ORDINAL

See Also:

Constant Field Values

GBA_TYPE_ORDINAL

public static final int GBA_TYPE_ORDINAL

See Also:

Constant Field Values

UE_ID_ORDINAL

public static final int UE_ID_ORDINAL

See Also:

Constant Field Values

UE_ID_TYPE_ORDINAL

public static final int UE_ID_TYPE_ORDINAL

See Also:

Constant Field Values

UICC_APP_LABEL_ORDINAL

public static final int UICC_APP_LABEL_ORDINAL

See Also:

Constant Field Values

UICC_ME_ORDINAL

public static final int UICC_ME_ORDINAL

See Also:

Constant Field Values

REQUESTED_KEY_LIFETIME_ORDINAL

public static final int REQUESTED_KEY_LIFETIME_ORDINAL

See Also:

Constant Field Values

PRIVATE_IDENTITY_REQUEST_ORDINAL

public static final int PRIVATE_IDENTITY_REQUEST_ORDINAL

See Also:

Constant Field Values

GBA_PUSH_INFO_ORDINAL

public static final int GBA_PUSH_INFO_ORDINAL

See Also:

Constant Field Values

NAF_SA_IDENTIFIER_ORDINAL

public static final int NAF_SA_IDENTIFIER_ORDINAL

See Also:

Constant Field Values

GBA_USER_SEC_SETTINGS

public static final Type<java.lang.String> GBA_USER_SEC_SETTINGS

The GAA-UserSecSettings AVP (AVP code 400) is of type OctetString. If transmitted on the Zh interface it contains GBA user security settings (GUSS). If transmitted on the Zn interface it contains the relevant USSs only. The content of GBA-UserSecSettings AVP is a XML document whose root element shall be the "guss" element for Zh interface and the "ussList" element for the Zn interface. The XML schema is defined in annex A.

TRANSACTION_IDENTIFIER

public static final Type<java.lang.String> TRANSACTION_IDENTIFIER

The Transaction-Identifier AVP (AVP code 401) is of type OctetString. This AVP contains the Bootstrapping Transaction Identifier (B-TID).

NAF_ID

public static final Type<java.lang.String> NAF_ID

The NAF-Id AVP (AVP code 402) is of type OctetString. This AVP contains the full qualified domain name (FQDN) of the NAF that the UE uses concatenated with the Ua security protocol identifier as specified in 3GPP TS 33.220 [5]. The FQDN of the NAF that is part of the NAF_Id may be a different domain name that with which the BSF knows the NAF.

GAA_SERVICE_IDENTIFIER

public static final Type<java.lang.String> GAA_SERVICE_IDENTIFIER

The GAA-Service-identifier AVP (AVP code 403) is of type OctedString. This AVP informs a BSF about the support of a GAA-service by the NAF. According this AVP the BSF can select the right service’s user security settings. For 3GPP standardized services (e.g., PKI portal), the GAA-Service-Identifier (GSID) shall be in the range 0 to 999999, and the currently standardized values for GSID shall be the GAA Service Type Code of the particular service. The GAA Service Type Codes for 3GPP standardized services are defined in Annex B. NOTE: In the future, standardized GSID values that are different than the GAA Service Type Code may be standardised (e.g. to differentiate between the services "MBMS streaming" and "MBMS download") and then several different GSID can exist within one GAA Service Type Code. Examples: The GSID is "1" for all PKI-portals, and "4" for all MBMS services.

KEY_EXPIRY_TIME

public static final Type<java.util.Date> KEY_EXPIRY_TIME

The Key-ExpiryTime AVP (AVP code 404) is of type Time. This AVP informs the NAF about the expiry time of the key.

ME_KEY_MATERIAL

public static final Type<java.lang.String> ME_KEY_MATERIAL

The required ME-Key-Material AVP (AVP code 405) is of type OctetString. The NAF is sharing this key material (Ks_NAF in the case of GBA_ME or Ks_ext_NAF in the case of GBA_U) with the Mobile Equipment (ME).

UICC_KEY_MATERIAL

public static final Type<java.lang.String> UICC_KEY_MATERIAL

The condition UICC-Key-Material AVP (AVP code 406) is of type OctetString. The NAF may share this key material (Ks_int_NAF in the case of GBA_U) with a security element (e.g. USIM, ISIM, etc..) in the UICC. Only some GAA applications use this conditional AVP.

GBA_U_AWARENESS_INDICATOR

public static final Type<Zh.GbaUAwarenessIndicator> GBA_U_AWARENESS_INDICATOR

The conditional GBA_U-Awareness-Indicator AVP (AVP code 407) is of type Enumerated. The following values are defined. NO (0) YES(1) The default value is 0 i.e. absence of this AVP indicates that the sending node is not GBA_U aware.

BOOTSTRAP_INFO_CREATION_TIME

public static final Type<java.util.Date> BOOTSTRAP_INFO_CREATION_TIME

The BootstrapInfoCreationTime AVP (AVP code 408) is of type Time. This AVP informs the NAF about the bootstrapinfo creation time of the key.

GUSS_TIMESTAMP

public static final Type<java.util.Date> GUSS_TIMESTAMP

The GUSS-Timestamp AVP (AVP code 409) is of type Time. If transmitted this AVP informs the HSS about the timestamp of the GUSS stored in the BSF.

GBA_TYPE

public static final Type<Zh.GbaType> GBA_TYPE

The GBA-Type AVP (AVP code 410) is of type Enumerated. The AVP informs the NAF about the authentication type that was used during bootstrapping procedure. The following values are defined: 3G GBA (0) The 3G GBA has been performed as defined in TS 33.220 [5]. 2G GBA (1) The 2G GBA has been performed as defined in TS 33.220 [5]. The default value is 0 i.e. the absence of this AVP indicates 3G GBA

UE_ID

public static final Type<java.lang.String> UE_ID

The UE-Id AVP (AVP code 411) is of type OctedString. The AVP informs the BSF the identity of the user.

UE_ID_TYPE

public static final Type<Zh.UeIdType> UE_ID_TYPE

The UE-Id-Type AVP (AVP code 412) is of type Enumerated. The AVP informs the BSF the type of the identity of the user. The following values are defined: • (0) Private user identity. • (1) Public user identity.

UICC_APP_LABEL

public static final Type<java.lang.String> UICC_APP_LABEL

The UICC-App-Label AVP (AVP code 413) is of type OctedString. The AVP informs the BSF the UICC application to be used for GBA push.

UICC_ME

public static final Type<Zh.UiccMe> UICC_ME

The UICC-ME AVP (AVP code 414) is of type Enumerated. The AVP informs the BSF the whether GBA_ME or GBA_U is to be used for GBA push. The following values are defined: • GBA_ME (0) GBA_ME shall be run. • GBA_U (1) GBA_U shall be run.

REQUESTED_KEY_LIFETIME

public static final Type<java.util.Date> REQUESTED_KEY_LIFETIME

The Requested-Key-Lifetime AVP (AVP code 415) is of type Time. The AVP informs the BSF about the requested lifetime for the NAF keys.

PRIVATE_IDENTITY_REQUEST

public static final Type<Zh.PrivateIdentityRequest> PRIVATE_IDENTITY_REQUEST

The Private-Identity-Request AVP (AVP code 416) is of type Enumerated. The AVP informs the BSF if the NAF requests the private identity of the user. The following values are defined: • Private identity requested (0) . • Private identity not requested (1)

GBA_PUSH_INFO

public static final Type<java.lang.String> GBA_PUSH_INFO

The GBA-Push-Info AVP (AVP code 417) is of type OctetString. The AVP includes the GBA-Push-Info as defined in 3GPP TS 33.223 [23].

NAF_SA_IDENTIFIER

public static final Type<java.lang.String> NAF_SA_IDENTIFIER

The NAF-SA-Identifier AVP (AVP code 418) is of type OctetString. The AVP contains the NAF-SA-Identifier (P-TID). See 3GPP TS 33.223 [23].

Constructor Detail

Zh

public Zh()