pap.h File Reference
PAP (Password Authentication Protocol) More...
Go to the source code of this file.
Data Structures | |
| struct | PapFsm |
| PAP finite state machine. More... | |
Macros | |
| #define | PAP_SUPPORT ENABLED |
| #define | PAP_RESTART_TIMER 3000 |
| #define | PAP_MAX_REQUESTS 5 |
Typedefs | |
| struct { | |
| char_t type | |
| uint32_t dataStart | |
| uint32_t dataLength | |
| uint8_t nameLength | |
| char_t name [] | |
| uint8_t tokenLen: 4 | |
| uint8_t type: 2 | |
| uint8_t version: 2 | |
| uint8_t code | |
| uint16_t mid | |
| uint8_t token [] | |
| union { | |
| uint8_t b [6] | |
| uint16_t w [3] | |
| } | |
| uint16_t srcPort | |
| uint16_t destPort | |
| uint32_t seqNum | |
| uint32_t ackNum | |
| uint8_t reserved1: 4 | |
| uint8_t dataOffset: 4 | |
| uint8_t flags: 6 | |
| uint8_t reserved2: 2 | |
| uint16_t window | |
| uint16_t checksum | |
| uint16_t urgentPointer | |
| uint8_t options [] | |
| uint16_t length | |
| uint8_t data [] | |
| uint8_t op | |
| uint8_t htype | |
| uint8_t hlen | |
| uint8_t hops | |
| uint32_t xid | |
| uint16_t secs | |
| uint16_t flags | |
| Ipv4Addr ciaddr | |
| Ipv4Addr yiaddr | |
| Ipv4Addr siaddr | |
| Ipv4Addr giaddr | |
| MacAddr chaddr | |
| uint8_t unused [10] | |
| uint8_t sname [64] | |
| uint8_t file [128] | |
| uint32_t magicCookie | |
| uint16_t type | |
| uint16_t hardwareType | |
| uint32_t time | |
| MacAddr linkLayerAddr | |
| uint16_t id | |
| uint8_t rd: 1 | |
| uint8_t tc: 1 | |
| uint8_t aa: 1 | |
| uint8_t opcode: 4 | |
| uint8_t qr: 1 | |
| uint8_t rcode: 4 | |
| uint8_t z: 3 | |
| uint8_t ra: 1 | |
| uint16_t qdcount | |
| uint16_t ancount | |
| uint16_t nscount | |
| uint16_t arcount | |
| uint8_t questions [] | |
| uint16_t controlWord | |
| uint16_t byteCount | |
| uint8_t bLength | |
| uint8_t bDescriptorType | |
| uint16_t bcdUsb | |
| uint8_t bDeviceClass | |
| uint8_t bDeviceSubClass | |
| uint8_t bDeviceProtocol | |
| uint8_t bMaxPacketSize0 | |
| uint16_t idVendor | |
| uint16_t idProduct | |
| uint16_t bcdDevice | |
| uint8_t iManufacturer | |
| uint8_t iProduct | |
| uint8_t iSerialNumber | |
| uint8_t bNumConfigurations | |
| uint8_t maxRespTime | |
| Ipv4Addr groupAddr | |
| uint16_t hrd | |
| uint16_t pro | |
| uint8_t hln | |
| uint8_t pln | |
| uint16_t op | |
| MacAddr sha | |
| Ipv4Addr spa | |
| MacAddr tha | |
| Ipv4Addr tpa | |
| uint8_t length | |
| uint8_t value [] | |
| uint16_t first | |
| uint16_t last | |
| uint16_t next | |
| union { | |
| uint8_t b [16] | |
| uint16_t w [8] | |
| uint32_t dw [4] | |
| } | |
| uint16_t maxRespDelay | |
| uint16_t reserved | |
| Ipv6Addr multicastAddr | |
| uint32_t reserved | |
| uint16_t pvid | |
| uint8_t autoNegSupportStatus | |
| uint16_t pmdAutoNegAdvCap | |
| uint16_t operationalMauType | |
| uint16_t capabilities | |
| uint8_t deviceType | |
| uint8_t lengthH: 1 | |
| uint8_t lengthL | |
| uint8_t t: 1 | |
| uint8_t c: 1 | |
| union { | |
| int32_t integer | |
| uint8_t octetString [1] | |
| uint8_t oid [1] | |
| uint8_t ipAddr [4] | |
| uint32_t counter32 | |
| uint32_t gauge32 | |
| uint32_t unsigned32 | |
| uint32_t timeTicks | |
| uint64_t counter64 | |
| } | |
| uint16_t transactionId | |
| uint16_t protocolId | |
| uint8_t unitId | |
| uint8_t pdu [] | |
| uint8_t retain: 1 | |
| uint8_t qos: 2 | |
| uint8_t dup: 1 | |
| union { | |
| uint8_t all | |
| struct { | |
| uint8_t topicIdType: 2 | |
| uint8_t cleanSession: 1 | |
| uint8_t will: 1 | |
| uint8_t retain: 1 | |
| uint8_t qos: 2 | |
| uint8_t dup: 1 | |
| } | |
| } | |
| uint8_t b: 1 | |
| uint8_t identifier | |
| uint8_t valueSize | |
| Ipv4Addr srcIpAddr | |
| Ipv4Addr destIpAddr | |
| Eui64 interfaceId | |
| uint16_t mru | |
| uint8_t peerIdLength | |
| uint8_t peerId [] | |
| uint32_t seconds | |
| uint32_t fraction | |
| uint16_t opcode | |
| char_t filename [] | |
| uint8_t reserved: 3 | |
| uint8_t fin: 1 | |
| uint8_t payloadLen: 7 | |
| uint8_t mask: 1 | |
| uint8_t extPayloadLen [] | |
| uint32_t length | |
| uint8_t payload [] | |
| uint8_t protocolVersionId | |
| uint8_t bpduType | |
| StpBridgeId rootId | |
| uint32_t rootPathCost | |
| StpBridgeId bridgeId | |
| uint16_t portId | |
| uint16_t messageAge | |
| uint16_t maxAge | |
| uint16_t helloTime | |
| uint16_t forwardDelay | |
| uint8_t version1Length | |
| uint16_t priority | |
| MacAddr addr | |
| } | PapAuthReqPacket |
| Authenticate-Request packet. More... | |
| struct { | |
| char_t type | |
| uint32_t dataStart | |
| uint32_t dataLength | |
| uint8_t nameLength | |
| uint8_t length: 4 | |
| uint8_t delta: 4 | |
| union { | |
| uint8_t b [8] | |
| uint16_t w [4] | |
| uint32_t dw [2] | |
| } | |
| uint8_t kind | |
| uint8_t value [] | |
| uint8_t code | |
| uint16_t type | |
| uint32_t enterpriseNumber | |
| uint8_t identifier [] | |
| uint16_t qtype | |
| uint16_t qclass | |
| uint16_t statusWord | |
| uint16_t byteCount | |
| uint8_t bLength | |
| uint8_t bDescriptorType | |
| uint16_t wTotalLength | |
| uint8_t bNumInterfaces | |
| uint8_t bConfigurationValue | |
| uint8_t iConfiguration | |
| uint8_t bmAttributes | |
| uint8_t bMaxPower | |
| uint8_t type | |
| uint16_t checksum | |
| uint8_t parameter | |
| uint8_t unused [3] | |
| uint8_t data [] | |
| uint32_t parameter | |
| uint8_t nextHeader | |
| uint8_t hdrExtLen | |
| uint8_t options [] | |
| uint8_t curHopLimit | |
| uint8_t reserved: 2 | |
| uint8_t p: 1 | |
| uint8_t prf: 2 | |
| uint8_t h: 1 | |
| uint8_t o: 1 | |
| uint8_t m: 1 | |
| uint16_t routerLifetime | |
| uint32_t reachableTime | |
| uint32_t retransTimer | |
| uint8_t flags | |
| uint16_t ppvid | |
| uint8_t mdiPowerSupport | |
| uint8_t psePowerPair | |
| uint8_t powerClass | |
| uint8_t appType | |
| uint8_t vlanIdH: 5 | |
| uint8_t x: 1 | |
| uint8_t t: 1 | |
| uint8_t u: 1 | |
| uint8_t l2PriorityH: 1 | |
| uint8_t vlanIdL: 7 | |
| uint8_t dscpValue: 6 | |
| uint8_t l2PriorityL: 2 | |
| uint8_t chassisIdSubtype | |
| uint8_t chassisId [] | |
| uint8_t functionCode | |
| uint16_t startingAddr | |
| uint16_t quantityOfCoils | |
| uint16_t length | |
| uint8_t msgType | |
| uint16_t flags | |
| Ipv4Addr addr | |
| uint8_t valueSize | |
| uint16_t protocol | |
| uint32_t accm | |
| uint8_t msgLength | |
| uint8_t message [] | |
| uint8_t mode: 3 | |
| uint8_t vn: 3 | |
| uint8_t li: 2 | |
| uint8_t stratum | |
| uint8_t poll | |
| int8_t precision | |
| uint32_t rootDelay | |
| uint32_t rootDispersion | |
| uint32_t referenceId | |
| NtpTimestamp referenceTimestamp | |
| NtpTimestamp originateTimestamp | |
| NtpTimestamp receiveTimestamp | |
| NtpTimestamp transmitTimestamp | |
| uint16_t opcode | |
| char_t filename [] | |
| uint16_t value [] | |
| uint16_t group | |
| uint8_t keyExchange [] | |
| uint32_t id | |
| uint32_t dataLen | |
| } | PapAuthAckPacket |
| Authenticate-Ack packet. More... | |
| struct { | |
| uint32_t totalSize | |
| ResRootEntry rootEntry | |
| MacAddr destAddr | |
| MacAddr srcAddr | |
| uint16_t type | |
| uint8_t data [] | |
| uint16_t hardwareType | |
| MacAddr linkLayerAddr | |
| uint16_t rtype | |
| uint16_t rclass | |
| uint32_t ttl | |
| uint16_t rdlength | |
| uint8_t rdata [] | |
| uint8_t bLength | |
| uint8_t bDescriptorType | |
| uint8_t bInterfaceNumber | |
| uint8_t bAlternateSetting | |
| uint8_t bNumEndpoints | |
| uint8_t bInterfaceClass | |
| uint8_t bInterfaceSubClass | |
| uint8_t bInterfaceProtocol | |
| uint8_t iInterface | |
| uint8_t type | |
| uint8_t code | |
| uint16_t checksum | |
| uint32_t unused | |
| uint8_t nextHeader | |
| uint8_t hdrExtLen | |
| uint8_t options [] | |
| uint32_t reserved | |
| Ipv6Addr targetAddr | |
| uint16_t vlanId | |
| uint8_t vlanNameLen | |
| char_t vlanName [] | |
| uint8_t aggregationStatus | |
| uint32_t aggregatedPortId | |
| uint8_t locationDataFormat | |
| uint8_t locationId [] | |
| uint8_t portIdSubtype | |
| uint8_t portId [] | |
| uint8_t functionCode | |
| uint8_t byteCount | |
| uint8_t coilStatus [] | |
| uint8_t prefix | |
| uint16_t length | |
| uint8_t msgType | |
| uint8_t identifier | |
| uint8_t message [] | |
| uint8_t length | |
| Ipv4Addr ipAddr | |
| uint16_t protocol | |
| uint8_t msgLength | |
| uint8_t rejectedPacket [] | |
| uint32_t keyId | |
| uint8_t messageDigest [16] | |
| uint16_t opcode | |
| uint16_t block | |
| uint16_t value [] | |
| uint8_t value [] | |
| } | PapAuthNakPacket |
| Authenticate-Nak packet. More... | |
Enumerations | |
| enum | PapState { PAP_STATE_0_INITIAL = 0, PAP_STATE_1_STARTED = 1, PAP_STATE_2_REQ_SENT = 2, PAP_STATE_3_REQ_RCVD = 3, PAP_STATE_4_ACK_SENT = 4, PAP_STATE_5_ACK_RCVD = 5, PAP_STATE_6_NAK_SENT = 6, PAP_STATE_7_NAK_RCVD = 7 } |
| PAP states. More... | |
| enum | PapCode { PAP_CODE_AUTH_REQ = 1, PAP_CODE_AUTH_ACK = 2, PAP_CODE_AUTH_NAK = 3 } |
| Code field values. More... | |
Functions | |
| error_t | papStartAuth (PppContext *context) |
| Start PAP authentication. More... | |
| error_t | papAbortAuth (PppContext *context) |
| Abort PAP authentication. More... | |
| void | papTick (PppContext *context) |
| PAP timer handler. More... | |
| void | papProcessPacket (PppContext *context, const PppPacket *packet, size_t length) |
| Process an incoming PAP packet. More... | |
| error_t | papProcessAuthReq (PppContext *context, const PapAuthReqPacket *authReqPacket, size_t length) |
| Process Authenticate-Request packet. More... | |
| error_t | papProcessAuthAck (PppContext *context, const PapAuthAckPacket *authAckPacket, size_t length) |
| Process Authenticate-Ack packet. More... | |
| error_t | papProcessAuthNak (PppContext *context, const PapAuthNakPacket *authNakPacket, size_t length) |
| Process Authenticate-Nak packet. More... | |
| error_t | papSendAuthReq (PppContext *context) |
| Send Authenticate-Request packet. More... | |
| error_t | papSendAuthAck (PppContext *context, uint8_t identifier) |
| Send Authenticate-Ack packet. More... | |
| error_t | papSendAuthNak (PppContext *context, uint8_t identifier) |
| Send Authenticate-Nak packet. More... | |
| bool_t | papCheckPassword (PppContext *context, const char_t *password) |
| Password verification. More... | |
Detailed Description
PAP (Password Authentication Protocol)
License
SPDX-License-Identifier: GPL-2.0-or-later
Copyright (C) 2010-2023 Oryx Embedded SARL. All rights reserved.
This file is part of CycloneTCP Open.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- Version
- 2.2.4
Definition in file pap.h.
Macro Definition Documentation
◆ PAP_MAX_REQUESTS
◆ PAP_RESTART_TIMER
◆ PAP_SUPPORT
Typedef Documentation
◆ PapAuthAckPacket
| typedef { ... } PapAuthAckPacket |
Authenticate-Ack packet.
◆ PapAuthNakPacket
| typedef { ... } PapAuthNakPacket |
Authenticate-Nak packet.
◆ PapAuthReqPacket
| typedef { ... } PapAuthReqPacket |
Authenticate-Request packet.
Enumeration Type Documentation
◆ PapCode
| enum PapCode |
◆ PapState
| enum PapState |
Function Documentation
◆ papAbortAuth()
| error_t papAbortAuth | ( | PppContext * | context | ) |
◆ papCheckPassword()
| bool_t papCheckPassword | ( | PppContext * | context, |
| const char_t * | password | ||
| ) |
◆ papProcessAuthAck()
| error_t papProcessAuthAck | ( | PppContext * | context, |
| const PapAuthAckPacket * | authAckPacket, | ||
| size_t | length | ||
| ) |
◆ papProcessAuthNak()
| error_t papProcessAuthNak | ( | PppContext * | context, |
| const PapAuthNakPacket * | authNakPacket, | ||
| size_t | length | ||
| ) |
◆ papProcessAuthReq()
| error_t papProcessAuthReq | ( | PppContext * | context, |
| const PapAuthReqPacket * | authReqPacket, | ||
| size_t | length | ||
| ) |
◆ papProcessPacket()
| void papProcessPacket | ( | PppContext * | context, |
| const PppPacket * | packet, | ||
| size_t | length | ||
| ) |
◆ papSendAuthAck()
| error_t papSendAuthAck | ( | PppContext * | context, |
| uint8_t | identifier | ||
| ) |
◆ papSendAuthNak()
| error_t papSendAuthNak | ( | PppContext * | context, |
| uint8_t | identifier | ||
| ) |
◆ papSendAuthReq()
| error_t papSendAuthReq | ( | PppContext * | context | ) |
◆ papStartAuth()
| error_t papStartAuth | ( | PppContext * | context | ) |
◆ papTick()
| void papTick | ( | PppContext * | context | ) |