oncrpc.c File Reference

SUN ONC RPC protocol. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include <errno.h>
#include <byteswap.h>
#include <ipxe/socket.h>
#include <ipxe/tcpip.h>
#include <ipxe/in.h>
#include <ipxe/iobuf.h>
#include <ipxe/dhcp.h>
#include <ipxe/xfer.h>
#include <ipxe/open.h>
#include <ipxe/uri.h>
#include <ipxe/features.h>
#include <ipxe/oncrpc.h>
#include <ipxe/oncrpc_iob.h>
#include <ipxe/init.h>
#include <ipxe/settings.h>
#include <ipxe/version.h>

Go to the source code of this file.

Macros
#define	SET_LAST_FRAME(x)   ( (x) | 1 << 31 )
	Set most significant bit to 1. More...
#define	GET_FRAME_SIZE(x)   ( (x) & ~( 1 << 31 ) )
#define	ONCRPC_CALL   0
#define	ONCRPC_REPLY   1

Functions
const struct setting uid_setting	__setting (SETTING_AUTH, uid)
const struct setting gid_setting	__setting (SETTING_AUTH, gid)
int	oncrpc_init_cred_sys (struct oncrpc_cred_sys *auth_sys)
	Initialize an ONC RPC AUTH SYS credential structure. More...
void	oncrpc_init_session (struct oncrpc_session *session, struct oncrpc_cred *credential, struct oncrpc_cred *verifier, uint32_t prog_name, uint32_t prog_vers)
	Prepare an ONC RPC session structure to be used by the ONC RPC layer. More...
int	oncrpc_call (struct interface *intf, struct oncrpc_session *session, uint32_t proc_name, const struct oncrpc_field fields[])
size_t	oncrpc_compute_size (const struct oncrpc_field fields[])
int	oncrpc_get_reply (struct oncrpc_session *session __unused, struct oncrpc_reply *reply, struct io_buffer *io_buf)
	Parse an I/O buffer to extract a ONC RPC REPLY. More...

Variables
struct oncrpc_cred	oncrpc_auth_none
	AUTH NONE authentication flavor. More...

Detailed Description

SUN ONC RPC protocol.

Definition in file oncrpc.c.

Macro Definition Documentation

SET_LAST_FRAME

#define SET_LAST_FRAME

(

x

)

( (x) | 1 << 31 )

Set most significant bit to 1.

Definition at line 49 of file oncrpc.c.

GET_FRAME_SIZE

#define GET_FRAME_SIZE

(

x

)

( (x) & ~( 1 << 31 ) )

Definition at line 50 of file oncrpc.c.

ONCRPC_CALL

#define ONCRPC_CALL   0

Definition at line 52 of file oncrpc.c.

ONCRPC_REPLY

#define ONCRPC_REPLY   1

Definition at line 53 of file oncrpc.c.

Function Documentation

__setting() [1/2]

const struct setting uid_setting __setting	(	SETTING_AUTH	,
		uid
	)

__setting() [2/2]

const struct setting gid_setting __setting	(	SETTING_AUTH	,
		gid
	)

oncrpc_init_cred_sys()

int oncrpc_init_cred_sys

(

struct oncrpc_cred_sys *

auth_sys

)

Initialize an ONC RPC AUTH SYS credential structure.

Parameters

auth_sys

The structure to initialize

The hostname field is filled with the value of the hostname setting, if the hostname setting is empty, PRODUCT_SHORT_NAME (usually "iPXE") is used instead.

Definition at line 84 of file oncrpc.c.

                                                              {
        if ( ! auth_sys )
                return -EINVAL;

        fetch_string_setting_copy ( NULL, &hostname_setting,
                                    &auth_sys->hostname );
        if ( ! auth_sys->hostname )
                if ( ! ( auth_sys->hostname = strdup ( product_short_name ) ) )
                        return -ENOMEM;

        auth_sys->uid         = fetch_uintz_setting ( NULL, &uid_setting );
        auth_sys->gid         = fetch_uintz_setting ( NULL, &uid_setting );
        auth_sys->aux_gid_len = 0;
        auth_sys->stamp       = 0;

        auth_sys->credential.flavor = ONCRPC_AUTH_SYS;
        auth_sys->credential.length = 16 +
                                      oncrpc_strlen ( auth_sys->hostname );

        return 0;
}

References oncrpc_cred_sys::aux_gid_len, oncrpc_cred_sys::credential, EINVAL, ENOMEM, fetch_string_setting_copy(), fetch_uintz_setting(), oncrpc_cred::flavor, oncrpc_cred_sys::gid, oncrpc_cred_sys::hostname, oncrpc_cred::length, NULL, ONCRPC_AUTH_SYS, oncrpc_strlen, product_short_name, oncrpc_cred_sys::stamp, strdup(), and oncrpc_cred_sys::uid.

Referenced by nfs_open().

oncrpc_init_session()

void oncrpc_init_session	(	struct oncrpc_session *	session,
		struct oncrpc_cred *	credential,
		struct oncrpc_cred *	verifier,
		uint32_t	prog_name,
		uint32_t	prog_vers
	)

Prepare an ONC RPC session structure to be used by the ONC RPC layer.

Parameters

session	ONC RPC session
credential	Credential structure pointer
verifier	Verifier structure pointer
prog_name	ONC RPC program number
prog_vers	ONC RPC program version number

Definition at line 115 of file oncrpc.c.

                                                {
        if ( ! session )
                return;

        session->rpc_id     = rand();
        session->credential = credential;
        session->verifier   = verifier;
        session->prog_name  = prog_name;
        session->prog_vers  = prog_vers;
}

References rand(), and session.

Referenced by mount_init_session(), nfs_init_session(), and portmap_init_session().

oncrpc_call()

int oncrpc_call	(	struct interface *	intf,
		struct oncrpc_session *	session,
		uint32_t	proc_name,
		const struct oncrpc_field	fields[]
	)

Definition at line 129 of file oncrpc.c.

                                                                           {
        size_t           frame_size;
        struct io_buffer *io_buf;

        if ( ! session )
                return -EINVAL;

        struct oncrpc_field header[] = {
                ONCRPC_FIELD ( int32, 0 ),
                ONCRPC_FIELD ( int32, ++session->rpc_id ),
                ONCRPC_FIELD ( int32, ONCRPC_CALL ),
                ONCRPC_FIELD ( int32, ONCRPC_VERS ),
                ONCRPC_FIELD ( int32, session->prog_name ),
                ONCRPC_FIELD ( int32, session->prog_vers ),
                ONCRPC_FIELD ( int32, proc_name ),
                ONCRPC_FIELD ( cred, session->credential ),
                ONCRPC_FIELD ( cred, session->verifier ),
                ONCRPC_FIELD_END,
        };

        frame_size  = oncrpc_compute_size ( header );
        frame_size += oncrpc_compute_size ( fields );

        io_buf = alloc_iob ( frame_size );
        if ( ! io_buf )
                return -ENOBUFS;

        header[0].value.int32 = SET_LAST_FRAME ( frame_size -
                                                 sizeof ( uint32_t ) );

        oncrpc_iob_add_fields ( io_buf, header );
        oncrpc_iob_add_fields ( io_buf, fields );

        return xfer_deliver_iob ( intf, iob_disown ( io_buf ) );
}

References alloc_iob(), EINVAL, ENOBUFS, header, iob_disown, ONCRPC_CALL, oncrpc_compute_size(), ONCRPC_FIELD, ONCRPC_FIELD_END, oncrpc_iob_add_fields(), ONCRPC_VERS, session, SET_LAST_FRAME, and xfer_deliver_iob().

Referenced by mount_mnt(), mount_umnt(), nfs_lookup(), nfs_read(), nfs_readlink(), and portmap_getport().

oncrpc_compute_size()

size_t oncrpc_compute_size

(

const struct oncrpc_field

fields[]

)

Definition at line 166 of file oncrpc.c.

                                                                  {

        size_t i;
        size_t size = 0;

        for ( i = 0; fields[i].type != oncrpc_none; i++ ) {
                switch ( fields[i].type ) {
                case oncrpc_int32:
                        size += sizeof ( uint32_t );
                        break;

                case oncrpc_int64:
                        size += sizeof ( uint64_t );
                        break;

                case oncrpc_str:
                        size += oncrpc_strlen ( fields[i].value.str );
                        break;

                case oncrpc_array:
                        size += oncrpc_align ( fields[i].value.array.length );
                        size += sizeof ( uint32_t );
                        break;

                case oncrpc_intarray:
                        size += sizeof ( uint32_t ) *
                                fields[i].value.intarray.length;
                        size += sizeof ( uint32_t );
                        break;

                case oncrpc_cred:
                        size += fields[i].value.cred->length;
                        size += 2 * sizeof ( uint32_t );
                        break;

                default:
                        return size;
                }
        }

        return size;
}

References oncrpc_field_value::cred, oncrpc_cred::length, oncrpc_align, oncrpc_array, oncrpc_cred, oncrpc_int32, oncrpc_int64, oncrpc_intarray, oncrpc_none, oncrpc_str, oncrpc_strlen, size, type, oncrpc_field::type, value, and oncrpc_field::value.

Referenced by oncrpc_call().

oncrpc_get_reply()

int oncrpc_get_reply	(	struct oncrpc_session *session	__unused,
		struct oncrpc_reply *	reply,
		struct io_buffer *	io_buf
	)

Parse an I/O buffer to extract a ONC RPC REPLY.

Parameters

session	ONC RPC session
reply	Reply structure where data will be saved
io_buf	I/O buffer

Definition at line 215 of file oncrpc.c.

                                                                              {
        if ( ! reply || ! io_buf )
                return -EINVAL;

        reply->frame_size = GET_FRAME_SIZE ( oncrpc_iob_get_int ( io_buf ) );
        reply->rpc_id     = oncrpc_iob_get_int ( io_buf );

        /* iPXE has no support for handling ONC RPC call */
        if ( oncrpc_iob_get_int ( io_buf ) != ONCRPC_REPLY )
                return -ENOSYS;

        reply->reply_state = oncrpc_iob_get_int ( io_buf );

        if ( reply->reply_state == 0 )
        {
                /* verifier.flavor */
                oncrpc_iob_get_int ( io_buf );
                /* verifier.length */
                iob_pull ( io_buf, oncrpc_iob_get_int ( io_buf ));

                /* We don't use the verifier in iPXE, let it be an empty
                   verifier. */
                reply->verifier = &oncrpc_auth_none;
        }

        reply->accept_state = oncrpc_iob_get_int ( io_buf );
        reply->data         = io_buf;

        return 0;
}

References oncrpc_reply::accept_state, oncrpc_reply::data, EINVAL, ENOSYS, oncrpc_reply::frame_size, GET_FRAME_SIZE, iob_pull, oncrpc_auth_none, oncrpc_iob_get_int, ONCRPC_REPLY, oncrpc_reply::reply_state, oncrpc_reply::rpc_id, and oncrpc_reply::verifier.

Referenced by nfs_deliver(), nfs_mount_deliver(), and nfs_pm_deliver().

Variable Documentation

oncrpc_auth_none

struct oncrpc_cred oncrpc_auth_none

Initial value:

= {
        .flavor = ONCRPC_AUTH_NONE,
        .length = 0
}

AUTH NONE authentication flavor.

Definition at line 56 of file oncrpc.c.

Referenced by mount_init_session(), nfs_init_session(), oncrpc_get_reply(), and portmap_init_session().