All Classes Namespaces Files Functions Pages
Layer2.Ppp.Auth.Pap Class Reference

Represents the Password Authentication Protocol. More...

Methods

 Description.Get
 Returns a textual description of the object.
 
 Parent.Get
 Returns the parent object.
 
 Password.Get
 Returns the configured password. More...
 
 Password.Set password
 Configures the password on the Password authentication Protocol ( PAP ) More...
 
 PeerID.Get
 Returns the configured Peer-ID. More...
 
 PeerID.Set peerID
 Configures the Peer-ID on the Password authentication Protocol ( PAP ) More...
 

Class overview

Represents the Password Authentication Protocol.

PPP defines an extensible Link Control Protocol, which allows negotiation of an Authentication Protocol for authenticating its peer before allowing Network Layer protocols to transmit over the link.

This class provides the Password Authentication protocol as described per RFC1334, section 2

The Password Authentication Protocol (PAP) provides a simple method for the peer to establish its identity using a 2-way handshake. This is done only upon initial link establishment.

After the Link Establishment phase is complete, an Id/Password pair is repeatedly sent by the peer to the authenticator until authentication is acknowledged or the connection is terminated.

PAP is not a strong authentication method. Passwords are sent over the circuit "\@emph{in the clear}", and there is no protection from playback or repeated trial and error attacks. The peer is in control of the frequency and timing of the attempts.

By default, authentication is not mandatory. If authentication of the link is desired, an implementation MUST specify the Authentication-Protocol Configuration Option during Link Establishment phase.

Since
2.5.0

Definition at line 5274 of file api.tcl.

Method documentation

Layer2.Ppp.Auth.Pap::Password.Get

Returns the configured password.

Returns
password
Example
1 $pap Password.Get

Returns:

p8ssw0rd  

Definition at line 5296 of file api.tcl.

Layer2.Ppp.Auth.Pap::Password.Set   password  

Configures the password on the Password authentication Protocol ( PAP )

The password will be transmitted plaintext over the wire.

Parameters
passwordThe password for the given Peer-ID
Example
1 $pap Password.Set "p8ssw0rd"

Definition at line 5310 of file api.tcl.

Layer2.Ppp.Auth.Pap::PeerID.Get

Returns the configured Peer-ID.

Returns
peerID
Example
1 $pap PeerID.Get

Returns:

pppoe-AC-1  

Definition at line 5322 of file api.tcl.

Layer2.Ppp.Auth.Pap::PeerID.Set   peerID  

Configures the Peer-ID on the Password authentication Protocol ( PAP )

Parameters
peerIDThe new Peer-ID
Example
1 $pap PeerID.Set "pppoe-AC-1"

Definition at line 5334 of file api.tcl.