riplib.html

Vxworks API操作系统和驱动程序设计API。压缩的HTML文件

    UINT   keyLen,            /* length of the secret key */
    UINT   authProto,         /* auth protocol to use (1 = MD5) */
    ULONG  timeValid          /* number of seconds until key expires */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is used to add a new RIP authentication key for a specific
interface.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
ERROR, if the interface does not exist, or the <i>keyId</i> already 
exists, or if the protocol is not supported; OK, if key was entered.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyDelete"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyDelete(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyDelete(&nbsp;)</strong> - delete an existing RIP authentication key</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripAuthKeyDelete
    (
    char * pInterfaceName,    /* interface to delete a key from */
    UINT16 keyId              /* the keyId of the key to delete */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is used to delete a RIP authentication key for a specific
interface.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
ERROR, if the interface does not exist, or the <i>keyId</i> does not 
exist; OK, if key was deleted.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyFind"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyFind(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyFind(&nbsp;)</strong> - find a RIP authentication key</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripAuthKeyFind
    (
    struct interface * ifp,   /* interface to search for key */
    UINT16             keyId, /* the keyId of the key to search for */
    RIP_AUTH_KEY * *   pKey   /* storage for the key data */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is used to find a RIP authentication key based on a specified
interface and keyId.  When a key is found, a pointer to the <b>RIP_AUTH_KEY</b>
struct for the key is stored in pKey.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
ERROR, if the key is not found; OK if the key was found.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyFindFirst"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyFindFirst(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyFindFirst(&nbsp;)</strong> - find a RIP authentication key</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripAuthKeyFindFirst
    (
    struct interface * ifp,   /* interface to search for key */
    RIP_AUTH_KEY * *   pKey   /* storage for the key data */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is used to find a RIP authentication key based on a specified
interface.  Because a <i>keyId</i> is not specified, this routine returns the 
first non-expired key found for the interface.  When a key is found, a 
pointer to the <b>RIP_AUTH_KEY</b> structure for the key is returned in <i>pKey</i>.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
ERROR, if a key is not found; OK, if a key was found.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyInMD5"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyInMD5(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyInMD5(&nbsp;)</strong> - authenticate an incoming RIP-2 message using MD5</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripAuthKeyInMD5
    (
    struct interface * ifp,   /* interface message received on */
    RIP_PKT *          pRip,  /* received RIP message */
    UINT               size   /* length of the RIP message */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is used to authenticate an incoming RIP-2 message using
the MD5 digest protocol.  This authentication scheme is described in
RFC 2082.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
ERROR, if could not authenticate; OK, if authenticated.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyOut1MD5"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyOut1MD5(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyOut1MD5(&nbsp;)</strong> - start MD5 authentication of an outgoing RIP-2 message</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripAuthKeyOut1MD5
    (
    struct interface *    pIfp,      /* interface message being sent on */
    struct netinfo *      pNetinfo,  /* pointer to next RIP entry to fill in */
    RIP2_AUTH_PKT_HDR * * ppAuthHdr, /* stores the authentication header */
    RIP_AUTH_KEY * *      ppAuthKey  /* stores the authentication key to use */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is used to start the authentication of an outgoing RIP-2
message by adding the authentication header used for MD5 authentication.
This authentication scheme is described in RFC 2082.  This function
returns a pointer the authentication header and a pointer to the looked up 
authentication key.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
ERROR, if a key could not be found; OK, if the header was added.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyOut2MD5"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyOut2MD5(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyOut2MD5(&nbsp;)</strong> - authenticate an outgoing RIP-2 message using MD5</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void ripAuthKeyOut2MD5
    (
    RIP_PKT *           pRip,     /* RIP message to authenticate */
    UINT *              pSize,    /* length of the RIP message */
    struct netinfo *    pNetinfo, /* pointer to next RIP entry to fill in */
    RIP2_AUTH_PKT_HDR * pAuthHdr, /* pointer to auth header in the message */
    RIP_AUTH_KEY *      pAuthKey  /* the auth key data to use */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine is used to authenticate an outgoing RIP-2 message using
the MD5 digest protocol.  This authentication scheme is described in
RFC 2082.  This function modifies the size given in pSize to account
for the extra auth trailer data.  The auth trailer is appended to the
given <b>RIP_PKT</b> and the authentication digest is filled in.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripIfExcludeListAdd"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripIfExcludeListAdd(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripIfExcludeListAdd(&nbsp;)</strong> - Add an interface to the RIP exclusion list</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripIfExcludeListAdd
    (
    char * pIfName            /* name of interface to be excluded */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This function adds the interface specified by <i>ifName</i> to a list of
interfaces on which RIP will not be started. This can be used to 
prevent RIP from starting on an interface.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK if the interface was successfully added to the list;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ERROR&nbsp;otherwise.
<p>
</blockquote><h4>NOTE</h4><blockquote><p>
This command must be issued prior to the interface being added<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;to&nbsp;the&nbsp;system,&nbsp;as&nbsp;RIP&nbsp;starts&nbsp;on&nbsp;an&nbsp;interface,&nbsp;unless&nbsp;it&nbsp;has&nbsp;been<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;excluded,&nbsp;as&nbsp;soon&nbsp;as&nbsp;an&nbsp;interface&nbsp;comes&nbsp;up.<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;RIP&nbsp;was&nbsp;already&nbsp;running&nbsp;on&nbsp;the&nbsp;interface&nbsp;which&nbsp;is&nbsp;now&nbsp;desired<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;to&nbsp;be&nbsp;excluded&nbsp;from&nbsp;RIP,&nbsp;the&nbsp;ripIfReset&nbsp;command&nbsp;should&nbsp;be&nbsp;used&nbsp;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;after&nbsp;the&nbsp;ripIfExcludeListAdd&nbsp;command.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripIfExcludeListDelete"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripIfExcludeListDelete(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripIfExcludeListDelete(&nbsp;)</strong> - Delete an interface from RIP exclusion list</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripIfExcludeListDelete
    (
    char * pIfName            /* name of un-excluded interface */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This function deletes the interface specified by <i>ifName</i> from the list of
interfaces on which RIP will not be started. That is, RIP will start on the
interface when it is added or comes up.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK if the interface was successfully removed from the list;<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ERROR&nbsp;otherwise.
<p>
</blockquote><h4>NOTE</h4><blockquote><p>
RIP will not automatically start on the interface. The <b><a href="./ripLib.html#ripIfSearch">ripIfSearch</a>(&nbsp;)</b> <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;call&nbsp;will&nbsp;need&nbsp;to&nbsp;be&nbsp;made&nbsp;after&nbsp;this&nbsp;call&nbsp;to&nbsp;cause&nbsp;RIP&nbsp;to&nbsp;start&nbsp;on<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;this&nbsp;interface.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripIfExcludeListShow"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripIfExcludeListShow(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripIfExcludeListShow(&nbsp;)</strong> - Show the RIP interface exclusion list</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void ripIfExcludeListShow (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This function prints out the interfaces on which RIP will not be started.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
Nothing
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

</body>
</html>