chap.h File Reference

CHAP protocol. More...

#include <stdint.h>
#include <ipxe/md5.h>

Go to the source code of this file.

Data Structures
struct	chap_response
	A CHAP response. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
int	chap_init (struct chap_response *chap, struct digest_algorithm *digest)
	Initialise CHAP challenge/response. More...
void	chap_update (struct chap_response *chap, const void *data, size_t len)
	Add data to the CHAP challenge. More...
void	chap_respond (struct chap_response *chap)
	Respond to the CHAP challenge. More...
void	chap_finish (struct chap_response *chap)
	Free resources used by a CHAP response. More...
static void	chap_set_identifier (struct chap_response *chap, unsigned int identifier)
	Add identifier data to the CHAP challenge. More...

Detailed Description

CHAP protocol.

Definition in file chap.h.

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

chap_init()

int chap_init	(	struct chap_response *	chap,
		struct digest_algorithm *	digest
	)

Initialise CHAP challenge/response.

Parameters

chap	CHAP challenge/response
digest	Digest algorithm to use

Return values

rc	Return status code

Initialises a CHAP challenge/response structure. This routine allocates memory, and so may fail. The allocated memory must eventually be freed by a call to chap_finish().

Definition at line 51 of file chap.c.

                                                  {
        size_t state_len;
        void *state;

        assert ( chap->digest == NULL );
        assert ( chap->digest_context == NULL );
        assert ( chap->response == NULL );

        DBG ( "CHAP %p initialising with %s digest\n", chap, digest->name );

        state_len = ( digest->ctxsize + digest->digestsize );
        state = malloc ( state_len );
        if ( ! state ) {
                DBG ( "CHAP %p could not allocate %zd bytes for state\n",
                      chap, state_len );
                return -ENOMEM;
        }
        
        chap->digest = digest;
        chap->digest_context = state;
        chap->response = ( state + digest->ctxsize );
        chap->response_len = digest->digestsize;
        digest_init ( chap->digest, chap->digest_context );
        return 0;
}

References assert(), digest_algorithm::ctxsize, DBG, chap_response::digest, chap_response::digest_context, digest_init(), digest_algorithm::digestsize, ENOMEM, malloc(), digest_algorithm::name, NULL, chap_response::response, chap_response::response_len, and state.

Referenced by eap_rx_md5(), iscsi_handle_chap_i_value(), and iscsi_handle_chap_r_value().

chap_update()

void chap_update	(	struct chap_response *	chap,
		const void *	data,
		size_t	len
	)

Add data to the CHAP challenge.

Parameters

chap	CHAP response
data	Data to add
len	Length of data to add

Definition at line 85 of file chap.c.

                                {
        assert ( chap->digest != NULL );
        assert ( chap->digest_context != NULL );

        if ( ! chap->digest )
                return;

        digest_update ( chap->digest, chap->digest_context, data, len );
}

References assert(), data, chap_response::digest, chap_response::digest_context, digest_update(), len, and NULL.

Referenced by chap_set_identifier(), eap_rx_md5(), iscsi_handle_chap_c_value(), iscsi_handle_chap_i_value(), and iscsi_handle_chap_r_value().

chap_respond()

void chap_respond

(

struct chap_response *

chap

)

Respond to the CHAP challenge.

Parameters

chap	CHAP response

Calculates the final CHAP response value, and places it in chap->response, with a length of chap->response_len.

Definition at line 104 of file chap.c.

                                                 {
        assert ( chap->digest != NULL );
        assert ( chap->digest_context != NULL );
        assert ( chap->response != NULL );

        DBG ( "CHAP %p responding to challenge\n", chap );

        if ( ! chap->digest )
                return;

        digest_final ( chap->digest, chap->digest_context, chap->response );
}

References assert(), DBG, chap_response::digest, chap_response::digest_context, digest_final(), NULL, and chap_response::response.

Referenced by eap_rx_md5(), iscsi_handle_chap_c_value(), and iscsi_handle_chap_r_value().

chap_finish()

void chap_finish

(

struct chap_response *

chap

)

Free resources used by a CHAP response.

Parameters

chap	CHAP response

Definition at line 122 of file chap.c.

                                                {
        void *state = chap->digest_context;

        DBG ( "CHAP %p finished\n", chap );

        free ( state );
        memset ( chap, 0, sizeof ( *chap ) );
}

References DBG, chap_response::digest_context, free, memset(), and state.

Referenced by eap_rx_md5(), iscsi_close_connection(), iscsi_free(), iscsi_handle_chap_i_value(), iscsi_handle_chap_r_value(), and iscsi_login_request_done().

chap_set_identifier()

static void chap_set_identifier ( struct chap_response *  chap, unsigned int  identifier  )

inlinestatic

Add identifier data to the CHAP challenge.

Parameters

chap	CHAP response
identifier	CHAP identifier

The CHAP identifier is the first byte of the CHAP challenge. This function is a notational convenience for calling chap_update() for the identifier byte.

Definition at line 46 of file chap.h.

                                                                   {
        uint8_t ident_byte = identifier;

        chap_update ( chap, &ident_byte, sizeof ( ident_byte ) );
}

References chap_update().

Referenced by eap_rx_md5(), iscsi_handle_chap_i_value(), and iscsi_handle_chap_r_value().