Bootstrapping Info Retrieval

/bootstrapping-info-retrieval

POST

Push Info Retrieval

/push-info-retrieval

POST

BootstrappingInfoRequest

M

1

Request body of the Bootstrapping Info Request

BootstrappingInfoResponse

M

1

200 OK

A response body containing the BootstrappingInfoResponse shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

ProblemDetails

O

0..1

403 Forbidden

The NAF is not authorized to request Bootstrapping Information from the GBA BSF.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

PushInfoRequest

M

1

Request body of the Push Info Request

PushInfoResponse

M

1

200 OK

A response body containing the PushInfoResponse shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

ProblemDetails

O

0..1

403 Forbidden

The Push-NAF is not authorized to request GBA Push Information (GPI) from the GBA BSF.

NOTE: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GBA BSF (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

BootstrappingInfoRequest

6.1.6.2.2

Request body of the HTTP POST operation for resource "/bootstrapping-info-request".

BootstrappingInfoResponse

6.1.6.2.3

Response body of the HTTP POST operation for resource "/bootstrapping-info-request".

PushInfoRequest

6.1.6.2.4

Request body of the HTTP POST operation for resource "/push-info-request".

PushInfoResponse

6.1.6.2.5

Response body of the HTTP POST operation for resource "/push-info-request".

NafId

6.1.6.2.6

NAF ID, containing the NAF FQDN and the Ua Security Protocol Identifier.

UssListItem

6.1.6.2.7

Data item in a User Security Settings array list.

Uss

6.1.6.2.8

User Security Settings for a given GAA Service.

UeIdsItem

6.1.6.2.9

Data item in a UE ID array list.

FlagsItem

6.1.6.2.10

Data item in a Flags array list.

GsId

6.1.6.3.2

GAA Service Identifier.

GsType

6.1.6.3.2

GAA Service Type.

BtId

6.1.6.3.2

Bootstrapping Transaction Identifier.

MeKeyMaterial

6.1.6.3.2

ME Key Material (hex-encoded string).

UiccKeyMaterial

6.1.6.3.2

UICC key material (hex-encoded string).

UeId

6.1.6.3.2

Public Identity of the UE.

Impi

6.1.6.3.2

IMS Private Identity of the UE

Flag

6.1.6.3.2

GAA authorization flags, as defined in 3GPP TS 29.109 [17], Annex C.

GbaPushInfo

6.1.6.3.2

GBA Push Info (hex-encoded string).

NafGroup

6.1.6.3.2

NAF Group (string).

PtId

6.1.6.3.2

P-TID.

UiccAppLabel

6.1.6.3.2

UICC Application Label (string).

Auts

6.1.6.3.2

AUTS in UMTS AKA.

Rand

6.1.6.3.2

RAND in UMTS AKA.

KeyChoice

6.1.6.3.3

Type of key (ME-based or UICC-based) that the NAF shall use.

UiccOrMe

6.1.6.3.4

Indicates whether GBA_ME or GBA_U is to be used for GBA push.

SecFeature

6.1.6.3.5

Security features supported by the BSF or the NAF.

GbaType

6.1.6.3.6

Authentication type used by the UE for GBA.

UeIdType

6.1.6.3.7

Type of UE Identity (public or private).

Uint32

3GPP TS 29.571 [18]

Unsigned 32-bit integer.

DateTime

3GPP TS 29.571 [18]

String with a "date-time" format, as defined by OpenAPI [6].

ProblemDetails

3GPP TS 29.571 [18]

Response body of error response messages.

RedirectResponse

3GPP TS 29.571 [18]

Response body of a redirect response message.

Fqdn

3GPP TS 29.571 [18]

Fully Qualified Domain Name

btId

BtId

M

1

Bootstrapping Transaction Identifier

nafId

NafId

M

1

NAF Identifier

gbaUAware

boolean

O

0..1

GBA-U Awareness Indicator.

true: The sending node is GBA_U aware

false (default) or absent: The sending node is not GBA_U aware.

gsIds

array(GsId)

O

1..N

GBA Service Identifiers

meKeyMaterial

MeKeyMaterial

M

1

ME key material (Ks_NAF or Ks_Ext_NAF)

uiccKeyMaterial

UiccKeyMaterial

O

0..1

UICC key material (Ks_Int_NAF)

keyExpiryTime

DateTime

O

0..1

Key expiry time

bootstrappingInfoCreationTime

DateTime

O

0..1

Bootstrapping Info Creation Time

ussList

array(UssListItem)

O

1..N

GBA User Security Settings per GBA Service Identifier

gbaType

GbaType

O

0..1

Authentication type that was used by the UE during the bootstrapping procedure.

impi

Impi

O

0..1

UE Private Identity

ueId

UeId

M

1

User Identity.

ueIdType

UeIdType

M

1

Type of UE identity (public or private).

uiccAppLabel

UiccAppLabel

M

1

UICC Application Label.

nafId

NafId

M

1

NAF Identifier.

ptId

PtId

M

1

P-TID (NAF SA Identifier).

uiccOrMe

UiccOrMe

M

1

Indicates whether GBA_ME or GBA_U is to be used for GBA push.

requestedLifeTime

DateTime

M

1

Requested key lifetime for the NAF keys.

privateIdRequest

boolean

O

0..1

Indicates to the BSF whether the UE private identity shall be returned to the NAF in the response message.

true: the private identity is requested by the NAF, and it shall be returned by the BSF.

false (default) or absent: the private identity is not requested by the NAF.

gbaUAware

boolean

O

0..1

GBA-U Awareness Indicator.

gsIds

array(GsId)

O

1..N

GBA Service Identifiers.

auts

Auts

O

0..1

AUTS in UMTS AKA.

rand

Rand

O

0..1

RAND in UMTS AKA.

securityFeaturesRequest

array(SecFeature)

O

1..N

Security Features supported by the NAF.

meKeyMaterial

MeKeyMaterial

M

1

ME key material (Ks_NAF or Ks_Ext_NAF).

gbaPushInfo

GbaPushInfo

M

1

GBA Push Info

uiccKeyMaterial

UiccKeyMaterial

O

0..1

UICC key material (Ks_Int_NAF).

keyExpiryTime

DateTime

O

0..1

Key expiry time.

bootstrappingInfoCreationTime

DateTime

O

0..1

Bootstrapping Info Creation Time.

ussList

array(UssListItem)

O

1..N

GBA User Security Settings per GBA Service Identifier

gbaType

GbaType

O

0..1

GBA Type.

impi

Impi

O

0..1

UE Private Identity.

securityFeaturesResponse

array(SecFeature)

O

0..N

If the BSF does not support the usage of securityFeatures or the NAF did not include any securityFeaturesRequest attribute in the PushInfoRequest message, this IE shall be absent.

If securityFeatures element is not defined in the GUSS of the UE, or there is no common securityFeature between NAF and BSF, the BSF shall include an empty array in the securityFeaturesResponse attribute.

nafFqdn

Fqdn

M

1

FQDN of the NAF.

uaSecProtId

string

M

1

Ua Security Protocol Identifier.

It shall contain 5 octets, as described in 3GPP TS 33.220 [14], encoded as a sequence of 10 hexadecimal characters.

pattern: "^[A-Fa-f0-9]{10}$"

uss

Uss

M

1

User Security Settings.

gsId

GsId

M

1

GAA Service ID.

gsType

GsType

M

1

GAA Service Type.

ueIds

array(UeIdsItem)

M

1..N

List of UE Identities

nafGroup

NafGroup

O

0..1

NAF Group.

flags

array(FlagsItem)

O

1..N

List of security flags supported for the current GAA service.

keyChoice

KeyChoice

O

0..1

Type of key that the NAF shall use.

ueId

UeId

M

1

Identity of the UE

flag

Flag

M

1

Security flag supported for the corresponding GAA Service.

GsId

Uint32

GAA Service Identifier.

For 3GPP standardized values, see 3GPP TS 29.109 [17], Annex B.

GsType

Uint32

GAA Service Type.

For 3GPP standardized values, see 3GPP TS 29.109 [17], Annex B.

BtId

string

Bootstrapping Transaction Identifier. It shall take the form of a NAI, where the realm part identifies the FQDN of the BSF. See 3GPP TS 33.220 [14].

MeKeyMaterial

string

ME key material, containing a 256-bit key, encoded as a sequence of 64 hexadecimal characters.

pattern: "^[A-Fa-f0-9]{64}$"

UiccKeyMaterial

string

UICC key material, containing a 256-bit key, encoded as a sequence of 64 hexadecimal characters.

pattern: "^[A-Fa-f0-9]{64}$"

UeId

string

Identity of the UE.

Impi

string

IMS Private Identity of the UE.

Flag

Uint32

GAA authorization flags, associated to the specific GAA Service Type, as defined in 3GPP TS 29.109 [17], Annex C.

GbaPushInfo

string

GBA Push Info binary data, as defined in 3GPP TS 33.223 [15], clause 5.3.5, encoded as a sequence of hexadecimal characters.

pattern: "^([A-Fa-f0-9]{2})+$"

NafGroup

string

NAF Group.

PtId

string

P-TID.

UiccAppLabel

string

UICC Application Label.

Auts

string

AUTS in UMTS AKA, containing a 112-bit value, encoded as a sequence of 28 hexadecimal characters.

pattern: "^[A-Fa-f0-9]{28}$"

Rand

string

RAND in UMTS AKA, containing a 128-bit value, encoded as a sequence of 32 hexadecimal characters.

pattern: "^[A-Fa-f0-9]{32}$"

"ME_BASED_KEY"

Ks_ NAF or Ks_ext_NAF shall be used by the NAF.

"UICC_BASED_KEY"

Ks_int_NAF shall be used by the NAF.

"ME_UICC_BASED_KEYS"

Ks_ext_NAF or Ks_int_NAF can be used by the NAF.

"GBA_ME"

GBA_ME shall be used.

"GBA_U"

GBA_U shall be used.

"GPL_U"

The UICC supports Generic Push Layer, as specified in 3GPP TS 33.224 [16].

"3G_GBA"

The 3G GBA has been performed as defined in 3GPP TS 33.220 [14].

"2G_GBA"

The 2G GBA has been performed as defined in 3GPP TS 33.220 [14], Annex I.

"GBA_DIGEST"

The GBA Digest has been performed as defined in 3GPP TS 33.220 [14], Annex M.

"PUBLIC"

Public user identity.

"PRIVATE"

Private user identity.