privkey.c File Reference

Private key. More...

#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <ipxe/dhcp.h>
#include <ipxe/settings.h>
#include <ipxe/x509.h>
#include <ipxe/privkey.h>

Go to the source code of this file.

Macros
#define	ALLOW_KEY_OVERRIDE   1

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
size_t	ABS_SYMBOL (private_key_len)
	__asm__ (".section \".rodata\", \"a\", " PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size private_key_data, ( . - private_key_data )\n\t" ".equ private_key_len, ( . - private_key_data )\n\t" ".previous\n\t")
static struct setting privkey_setting	__setting (SETTING_CRYPTO, privkey)
	Private key setting.
void	privkey_free (struct refcnt *refcnt)
	Free private key.
static int	privkey_apply_settings (void)
	Apply private key configuration settings.

Variables
char	private_key_data []
struct private_key	private_key
	Private key.
static struct asn1_cursor	default_private_key
	Default private key.
struct settings_applicator privkey_applicator	__settings_applicator
	Private key settings applicator.

Detailed Description

Private key.

Life would in theory be easier if we could use a single file to hold both the certificate and corresponding private key. Unfortunately, the only common format which supports this is PKCS#12 (aka PFX), which is too ugly to be allowed anywhere near my codebase. See, for reference and amusement:

http://www.cs.auckland.ac.nz/~pgut001/pubs/pfx.html

Definition in file privkey.c.

Macro Definition Documentation

ALLOW_KEY_OVERRIDE

#define ALLOW_KEY_OVERRIDE   1

Definition at line 52 of file privkey.c.

Referenced by privkey_apply_settings().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ABS_SYMBOL()

size_t ABS_SYMBOL ( private_key_len )

extern

__asm__()

__asm__	(	".section \".rodata\"	,
		\"a\"	,
		" PROGBITS "\n\t" "\nprivate_key_data:\n\t" ".size	private_key_data,
		(. - private_key_data)\n\t" ".equ	private_key_len,
		(. - private_key_data)\n\t" ".previous\n\t"	)

References PROGBITS.

Referenced by __attribute__(), __attribute__(), __attribute__(), __attribute__(), __attribute__(), __attribute__(), __attribute__(), __attribute__(), __attribute__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), __volatile__(), _dump_regs(), apm_poweroff(), asm(), asm(), asm(), asm(), bios_cpu_nap(), bios_currticks(), bios_getchar(), bios_handle_cup(), bios_handle_dectcem_reset(), bios_handle_dectcem_set(), bios_handle_ed(), bios_inject(), bios_inject_startup(), bios_iskey(), bios_mp_exec_boot(), bios_putchar(), bios_reboot(), bochsbp(), bzimage_exec(), call_bootsector(), com32_cfarcall(), com32_exec_loop(), com32_farcall(), com32_intcall(), comboot_exec_loop(), comboot_force_text_mode(), copy_from_real_libkir(), copy_to_real_libkir(), cpuid_instruction_supported(), elfboot_exec(), extmemsize_88(), extmemsize_e801(), fake_e820(), gdbmach_breakpoint(), gdbmach_handler(), gdbmach_update(), hook_comboot_interrupts(), i386_readq(), i386_writeq(), if(), int13_hook_vector(), int13_load_eltorito(), int13_load_mbr(), int13con_init(), int13con_rw(), int22(), interrupt(), IOAPI_INLINE(), IOAPI_INLINE(), iounmap_pages(), librm_test_exec(), meme820(), multiboot_exec(), nbi_boot16(), nbi_boot32(), pcibios_discover(), pcibios_read(), pcibios_write(), pxe_activate(), pxe_start_nbp(), rdrand_get_noise(), rdtsc_raw(), rdtsc_scaled(), rtc_entropy_check(), rtc_get_noise(), rtc_hook_isr(), sdi_exec(), stack_check(), tcpip_continue_chksum(), undi_load(), undinet_call(), undinet_poll(), vesafb_font(), vesafb_init(), vesafb_mode_info(), vesafb_mode_list(), vesafb_restore(), and vesafb_set_mode().

__setting()

struct setting privkey_setting __setting ( SETTING_CRYPTO , privkey  )

static

Private key setting.

References __setting, DHCP_EB_KEY, and SETTING_CRYPTO.

privkey_free()

void privkey_free

(

struct refcnt *

refcnt

)

Free private key.

Parameters

refcnt

Reference counter

Definition at line 95 of file privkey.c.

                                            {
        struct private_key *key =
                container_of ( refcnt, struct private_key, refcnt );
 
        free ( key->builder.data );
        free ( key );
}

References container_of, free, and key.

Referenced by privkey_init().

privkey_apply_settings()

int privkey_apply_settings ( void )

static

Apply private key configuration settings.

Return values

rc	Return status code

Definition at line 108 of file privkey.c.

                                           {
        static void *key_data = NULL;
        int len;
 
        /* Allow private key to be overridden only if not explicitly
         * specified at build time.
         */
        if ( ALLOW_KEY_OVERRIDE ) {
 
                /* Restore default private key */
                memcpy ( &private_key.builder, &default_private_key,
                         sizeof ( private_key.builder ) );
 
                /* Fetch new private key, if any */
                free ( key_data );
                if ( ( len = fetch_raw_setting_copy ( NULL, &privkey_setting,
                                                      &key_data ) ) >= 0 ) {
                        private_key.builder.data = key_data;
                        private_key.builder.len = len;
                }
        }
 
        /* Debug */
        if ( private_key.builder.len ) {
                DBGC ( &private_key, "PRIVKEY using %s private key:\n",
                       ( key_data ? "external" : "built-in" ) );
                DBGC_HDA ( &private_key, 0, private_key.builder.data,
                           private_key.builder.len );
        } else {
                DBGC ( &private_key, "PRIVKEY has no private key\n" );
        }
 
        return 0;
}

References ALLOW_KEY_OVERRIDE, private_key::builder, asn1_builder::data, DBGC, DBGC_HDA, default_private_key, fetch_raw_setting_copy(), free, asn1_builder::len, len, memcpy(), and NULL.

Variable Documentation

private_key_data

char private_key_data[]

extern

private_key

struct private_key private_key

Initial value:

= {
        .refcnt = REF_INIT ( ref_no_free ),
        .builder = {
                .data = private_key_data,
                .len = ABS_VALUE_INIT ( private_key_len ),
        },
}

Private key.

Definition at line 68 of file privkey.c.

                                 {
        .refcnt = REF_INIT ( ref_no_free ),
        .builder = {
                .data = private_key_data,
                .len = ABS_VALUE_INIT ( private_key_len ),
        },
};

default_private_key

struct asn1_cursor default_private_key

static

Initial value:

= {
        .data = private_key_data,
        .len = ( ( size_t ) private_key_len ),
}

Default private key.

Definition at line 77 of file privkey.c.

                                                {
        .data = private_key_data,
        .len = ( ( size_t ) private_key_len ),
};

Referenced by privkey_apply_settings().

__settings_applicator

struct settings_applicator privkey_applicator __settings_applicator

Initial value:

= {
        .apply = privkey_apply_settings,
}

Private key settings applicator.

Definition at line 144 of file privkey.c.

                                                                      {
        .apply = privkey_apply_settings,
};