CALL:SECurity

Last updated: October 30, 2013

GPIB Command Conventions

CALL:SECurity:AUTHenticate[:KEY]

Function

Sets/queries the Authentication Key .

This setting is not useful until the security operation mode is set to other than "NONE". See CALL:SECurity:OPERation .

Setting

Range: 0 to FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
(1 to 32 characters from the set 0123456789aAbBcCdDeEfF)

Query

Range: "00000000:00000000:00000000:00000000" to FFFFFFFF:FFFFFFFF:FFFFFFFF:FFFFFFFF
(The return string is always four colon separated groups in the order of upper, upper middle, lower middle and lower, each group with 8 characters from the set 0123456789ABCDEF, enclosed by double quotes)

*RST Setting

"4147494C:454E5420:54454348:4E4F0000"
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate '4147494C454E5420544543484E4F0000'"
! Sets the authentication key to 4147494C:454E5420:54454348:4E4F0000.

CALL:SECurity:AUTHenticate:ALGorithm

Function

Sets/queries the Authentication Algorithm .

This setting is not useful until the security operation mode is set to other than "NONE". See CALL:SECurity:OPERation .

Setting

Range:

  • RIJNdael (Milenage)
  • TEST34108

Query

Range: RIJN|TEST34108

*RST Setting

TEST34108
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:ALGorithm RIJN"
!Sets the authentication algorithm to Milenage (Rijndael).

CALL:SECurity:AUTHenticate:AMF

Function

Sets/queries the AMF Value .

This setting is not useful until the security operation mode is set to other than "NONE". See CALL:SECurity:OPERation .

Setting

Range: 0 to FFFF
(1 to 4 characters from the set 0123456789aAbBcCdDeEfF)

Query

Range: "0000" to "FFFF"
(The return string is always 4 characters from the set 0123456789ABCDEF, enclosed by double quotes)

*RST Setting

"0000"
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:AMF 'FFFF'"
!Sets the AMF value to FFFF.

CALL:SECurity:AUTHenticate:OPVariant:PTYPe

Function

Sets/queries the Operator Variant Parm Type . You must then enter a value for Operator Variant Auth Alg (CALL:SECurity:AUTHenticate:OPVariant:PVALue ).

This setting is not useful until the security operation mode is set to other than "NONE". See CALL:SECurity:OPERation .

Setting

Range: OP|OPC

Query

Range: OP|OPC

*RST Setting

OPC
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:OPVariant:PTYPe OP"
!Sets the Operator Variant Authentication Parameter type to OP.

CALL:SECurity:AUTHenticate:OPVariant:PVALue

Function

Sets/queries the value of the Operator Variant Auth Alg .

You must indicate, using the Operator Variant Parm Type setting (CALL:SECurity:AUTHenticate:OPVariant:PTYPe ), whether this setting contains OP or OPc.

This setting is not useful until the security operation mode is set to other than "NONE". See CALL:SECurity:OPERation .

Setting

Range: 0 to FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
(1 to 32 characters from the set 0123456789aAbBcCdDeEfF)

Query

Range: "00000000:00000000:00000000:00000000" to "FFFFFFFF:FFFFFFFF:FFFFFFFF:FFFFFFFF"
(The return string is always four colon separated groups in the order of upper, upper middle, lower middle and lower, each group with 8 characters from the set 0123456789ABCDEF, enclosed by double quotes)

*RST Setting

"00000000:00000000:00000000:00000000"
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:OPVariant:PVALue '10F'"
! Sets the value of Operator Variant Authentication
! Parameter to 00000000:00000000:00000000:0000010F.

CALL:SECurity:AUTHenticate:RANDom

Function

Sets/queries the Random (RAND) Value .

This setting is not useful until the security operation mode is set to other than "NONE". See CALL:SECurity:OPERation .

Setting

Range: 0 to FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
(1 to 32 characters from the set 0123456789aAbBcCdDeEfF)

Query

Range: "00000000:00000000:00000000:00000000" to "FFFFFFFF:FFFFFFFF:FFFFFFFF:FFFFFFFF"
(The return string is always four colon separated groups in the order of upper, upper middle, lower middle and lower, each group with 8 characters from the set 0123456789ABCDEF, enclosed by double quotes)

*RST Setting

"00000000:00000000:00000000:00000001"
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:RANDom 'A'"
!Sets the random value of the Authentication Parameter to 00000000:00000000:00000000:0000000A.

CALL:SECurity:AUTHenticate:RESult:GMM?

Function

Queries the Authentication Result: GMM .

Query

Range: SUCCess|MSFAILMAC|MSFAILSYNC|MSFAILUNKNOWN|RESLENERR|
RESNOTMATCH|NULL

  • SUCCess - MS Authentication Success
  • MSFAILMAC - MS Authentication Failure, with a reject cause of MAC Does not Match
  • MSFAILSYNC - MS Authentication Failure, with a reject cause of Synch Failure
  • MSFAILUNKNOWN - MS Authentication Failure, with a reject cause of Unknown
  • RESLENERR - MS Authentication Failure, with a reject cause of Incorrect RES Length
  • RESNOTMATCH - MS Authentication Failure, with a reject cause of RES does not Match

*RST Setting

NULL
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:RESult:GMM?"
!Queries the GMM authentication result.

CALL:SECurity:AUTHenticate:RESult[:MM]?

Function

Queries the Authentication Result: MM .

Query

Range: SUCCess|MSFAILMAC|MSFAILSYNC|MSFAILUNKNOWN|RESLENERR|
RESNOTMATCH|NULL

  • SUCCess - MS Authentication Success
  • MSFAILMAC - MS Authentication Failure, with a reject cause of MAC Does not Match
  • MSFAILSYNC - MS Authentication Failure, with a reject cause of Synch Failure
  • MSFAILUNKNOWN - MS Authentication Failure, with a reject cause of Unknown
  • RESLENERR - MS Authentication Failure, with a reject cause of Incorrect RES Length
  • RESNOTMATCH - MS Authentication Failure, with a reject cause of RES does not Match

*RST Setting

NULL
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:RESult?"
!Queries the MM authentication result.

CALL:SECurity:AUTHenticate:RIJNdael:CPARameter

Function

Sets/queries the C parameters used in milenage algorithms.

Setting

Range: 000... to FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
(A list of 5 elements with each entry being a 32-Hexadecimal string ranging from 000... to FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF)

Query

 Same as setting.

*RST Setting

 00000000000000000000000000000000,00000000000000000000000000000001,00000000000000000000000000000002,00000000000000000000000000000004,00000000000000000000000000000008
Requirements Lab Application Revision: I.00.00 and above

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:RIJNdael:CPARameter?"
!Queries the milenage C parameters.

CALL:SECurity:AUTHenticate:RIJNdael:RPARameter

Function

Sets/queries the R parameters used in milenage algorithms.

Setting

Range: 0 to 127
(A list of 5 elements with each entry being a decimal string ranging from 0 to 127.)

Query

 Same as setting.

*RST Setting

 64, 0, 32, 64, 96
Requirements Lab Application Revision: I.00.00 and above

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:RIJNdael:RPARameter?"
!Queries the milenage R parameters.

CALL:SECurity:AUTHenticate:SQN:RESet[:IMMediate]

Function

Resets the authentication sequence number (SQN) to zero (see Reset Authentication SQN ).
Requirements

Test Application Revision: A.03 and above.

Lab Application Revision: A.01 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:AUTHenticate:SQN:RESet"
!Resets the authentication SQN.

CALL:SECurity:EISV:REQuest[:STATe]

Function

Sets/queries IMEISV Request State .

Setting

Range: 1|ON|0|OFF

Query

 Same as setting.

*RST Setting

 0 (OFF)
Requirements Lab Application Revision: J.00.00 and above

Programming Example

 
OUTPUT 714;"CALL:SECurity:EISV:REQuest ON"
!Requests the UE to report its IMEISV value via authentication and ciphering response message.

CALL:SECurity:MS:REPorted:EISV?

Function

Queries the IMEISV value the UE reported via authentication and ciphering response message.

Setting

Range:

  • ""(Null) or
  • 0000000000000000 to FFFFFFFFFFFFFFFF (16 characters, `0' - `9', `A' - `F' in each character)

Query

 Same as setting.

*RST Setting

 ""(Null)
Requirements Lab Application Revision: J.00.00 and above

Programming Example

 
OUTPUT 714;"CALL:SECurity:MS:REPorted:EISV?"
!Queries the IMEISV value reported by the UE.

CALL:SECurity:OPERation

Function

Sets/queries Security Operations .

Setting

Range: NONE|AUTHONLY|AUTHINT|AICiphering

  • NONE - No security procedures are performed
  • AUTHONLY - Authentication only
  • AUTHINT - Authentication and integrity protection
  • AICiphering - Authentication, integrity protection and ciphering

Query

Range: NONE|AUTHONLY|AUTHINT|AIC

*RST Setting

AUTHINT
Requirements

Test Application Revision: A.03 and above.
Lab Application Revision: A.01 and above.
Test Application Revision: A.06 and above, *RST value changed from NONE to AUTHINT
Lab Application Revision: C.01 and above, *RST value changed from NONE to AUTHINT
Lab Application Revision: F.00.19 and above, added AICiphering: requires an additional feature license.

Programming Example

 
OUTPUT 714;"CALL:SECurity:OPERation AUTHONLY"
!Sets the security procedure with authentication only.

CALL:SECurity:RESult:INTegrity:KEY?

Function

Queries the Integrity Key .

This result is only applicable for the security operation mode of "Authentication and Integrity Protection" or "Authentication, Integrity Protection and Ciphering". See CALL:SECurity:OPERation .

Setting

Range: 0 to FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
(1 to 32 characters from the set 0123456789aAbBcCdDeEfF)

Query

Range: "00000000:00000000:00000000:00000000" to FFFFFFFF:FFFFFFFF:FFFFFFFF:FFFFFFFF
(The return string is always four colon separated groups in the order of upper, upper middle, lower middle and lower, each group with 8 characters from the set 0123456789ABCDEF, enclosed by double quotes)
Requirements

Test Application Revision: A.17.00 and above.
Lab Application Revision: G.01.00 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:RESult:INTegrity:key?"
! Query the integrity key.

CALL:SECurity:RESult:CIPHering:KEY?

Function

Queries the Ciphering Key .

This result is only applicable for the security operation mode of "Authentication, Integrity Protection and Ciphering". See CALL:SECurity:OPERation .

Setting

Range: 0 to FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
(1 to 32 characters from the set 0123456789aAbBcCdDeEfF)

Query

Range: "00000000:00000000:00000000:00000000" to FFFFFFFF:FFFFFFFF:FFFFFFFF:FFFFFFFF
(The return string is always four colon separated groups in the order of upper, upper middle, lower middle and lower, each group with 8 characters from the set 0123456789ABCDEF, enclosed by double quotes)
Requirements

Test Application Revision: A.17.00 and above.
Lab Application Revision: G.01.00 and above.

Programming Example

 
OUTPUT 714;"CALL:SECurity:RESult:CIPHering:key?"
! Sets the ciphering key.