Module ocs_eap_codec
This library module implements encoding and decoding (CODEC)
functions for the Extensible Authentication Protocol (EAP) in the
ocs application.
Copyright © 2016 - 2026 SigScale Global Inc.
References
This library module implements encoding and decoding (CODEC)
functions for the Extensible Authentication Protocol (EAP) in the
ocs application.
eap_packet(Packet) -> Result
- Packet = binary() | #eap_packet{code = request | response | success | failure | undefined, type = byte() | undefined, identifier = byte() | undefined, data = binary() | undefined}
- Result = #eap_packet{code = request | response | success | failure | undefined, type = byte() | undefined, identifier = byte() | undefined, data = binary() | undefined} | binary()
Encode or decode an EAP packet.
eap_pwd(Packet) -> Result
- Packet = binary() | #eap_pwd{length = boolean() | undefined, more = boolean() | undefined, pwd_exch = id | commit | confirm, tot_length = 0..65535 | undefined, data = binary() | undefined}
- Result = #eap_pwd{length = boolean() | undefined, more = boolean() | undefined, pwd_exch = id | commit | confirm, tot_length = 0..65535 | undefined, data = binary() | undefined} | binary()
Encode or Decode an EAP-PWD-Header packet transported in the
RADIUS EAP-Message attribute.
RFC-5931 3.1
eap_pwd_id(Packet) -> Result
- Packet = binary() | #eap_pwd_id{group_desc = byte() | undefined, random_fun = byte() | undefined, prf = byte() | undefined, token = binary() | undefined, pwd_prep = none | rfc2759 | saslprep, identity = binary() | undefined}
- Result = #eap_pwd_id{group_desc = byte() | undefined, random_fun = byte() | undefined, prf = byte() | undefined, token = binary() | undefined, pwd_prep = none | rfc2759 | saslprep, identity = binary() | undefined} | binary()
Encode or Decode EAP-pwd-ID
RFC-5931 3.2.1
Comprise the Ciphersuite included in the calculation of the
peer's and server's confirm messages
eap_pwd_commit(Packet) -> Result
- Packet = binary() | #eap_pwd_commit{element = binary() | undefined, scalar = binary() | undefined1}
- Result = #eap_pwd_commit{element = binary() | undefined, scalar = binary() | undefined1} | binary()
Encode or Decode EAP-pwd-commit
RFC-5931 3.2.2
Element, Scalar are generated by server (in EAP-PWD-Commit/Request) and
peer (in EAP-PWD-Commit/Response)
eap_ttls(Packet) -> Result
- Packet = binary() | #eap_ttls{more = boolean() | undefined, start = boolean() | undefined, version = 0..7, message_len = integer() | undefined, data = binary() | undefined}
- Result = #eap_ttls{more = boolean() | undefined, start = boolean() | undefined, version = 0..7, message_len = integer() | undefined, data = binary() | undefined} | binary()
Encode or Decode EAP-TTLS packet
RFC-5281 9.1
eap_aka(Message) -> Message
- Message = binary() | #eap_aka_identity{permanent_id_req = boolean() | undefined, any_id_req = boolean() | undefined, fullauth_id_req = boolean() | undefined, identity = binary() | undefined} | #eap_aka_challenge{rand = binary() | undefined, autn = binary() | undefined, res = bitstring() | undefined, kdf = [1..65535] | undefined, network = binary() | undefined, next_pseudonym = binary() | undefined, next_reauth_id = binary() | undefined, iv = binary() | undefined, encr_data = binary() | undefined, checkcode = binary() | undefined, result_ind = boolean() | undefined, mac = binary() | undefined} | #eap_aka_reauthentication{next_reauth_id = binary() | undefined, iv = binary() | undefined, encr_data = binary() | undefined, checkcode = binary() | undefined, result_ind = boolean() | undefined, mac = binary() | undefined, counter = 0..65535 | undefined, counter_too_small = boolean() | undefined, nonce_s = binary() | undefined} | #eap_aka_notification{iv = binary() | undefined, encr_data = binary() | undefined, mac = binary() | undefined, counter = 0..65535 | undefined, notification = 0..65535 | undefined} | #eap_aka_authentication_reject{} | #eap_aka_synchronization_failure{auts = binary() | undefined, kdf = [1..65535] | undefined} | #eap_aka_client_error{client_error_code = 0..65535 | undefined}
Encode or decode an EAP-AKA message.
RFC4187 section 8.1
aka_clear_mac(EapMessage) -> EapMessage
Zero out the EAP-AKA' message authentication code (MAC).
aka_set_mac(MAC, EapMessage) -> EapMessage
- MAC = binary()
- EapMessage = binary()
Overwrite value of the EAP-AKA' message authentication code (MAC).
Generated by EDoc
