Commit Graph
7757 Commits
Author SHA1 Message Date
Michael Brown 89cfb681a4 [tls] Add a standalone TLS data structure parser
iPXE originally supported only TLS version 1.0, which uses mostly
fixed-size data structures and required only a few mostly simple
bounds checks.

Over the years, the amount of open-coded parsing and bounds checking
code has grown gradually to the point that it comprises a substantial
portion of the overall TLS implementation.  This makes the code
difficult to read, and requires careful review to ensure that all of
the different parsing and bounds checking code is correct.

Define an abstraction for decomposing the component parts of a TLS
data structure into a descriptor structure comprising a sequence of
field data pointers and lengths, along with an efficient binary
encoding that can describe the mapping between the decomposition and
the raw data structure.

Provide a generic parser that can interpret the binary-encoded mapping
and populate the descriptor structure, along with mappings for every
data structure currently interpreted by the TLS protocol engine.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-18 15:01:14 +01:00
Michael Brown 1135b79660 [tls] Fix building with TLS_VERSION_MAX set to TLS version 1.1
Commit 356bb14 ("[tls] Detect version downgrade attacks") introduced a
build failure under -Werror and -Wtype-limits when TLS_VERSION_MAX is
set to TLS_VERSION_TLS_1_1 due to the constructed test that checks if
an unsigned integer is less than zero.

Downgrade attack detection is impossible anyway when the maximum
version offered is TLS version 1.1, and so this always-false test is
perfectly correct: the desired outcome is that the downgrade detection
is optimised out at build time.

Fix the build error by adjusting the comparison to be performed using
signed integers to avoid the -Wtype-limits check.  Add a separate
check that the maximum version is higher than TLS_VERSION_TLS_1_1 to
ensure that the whole downgrade detection code block is optimised out
as dead code if it cannot ever be reached.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-18 15:01:12 +01:00
Michael Brown 01081fd911 [libc] Set return type for byte-swapping macros regardless of endianness
When the byte-swapping macros are no-ops (i.e. when they match the
platform's native endianness), the type of the parameter is used
directly as the type of the expression.  This can result in the type
of the expression differing between little-endian and big-endian
platforms.

Fix by including a cast within the no-op variants, so that the type of
the expression is consistent across all platforms.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-18 12:52:57 +01:00
Michael Brown 7cd92e01d6 [tls] Handle TLS version 1.3 client Finished
The TLS version 1.3 client Finished is somewhat messy to handle: its
verify_data must be calculated with the key schedule still holding the
client handshake traffic secret, the application traffic secret must
be calculated before the client Finished is added to the transcript
digest, and the application traffic keys must be activated only after
sending the client Finished.  Since the action of sending the client
Finished also adds the client Finished to the transcript digest, this
necessitates an awkward sequence of events.  (A cleaner protocol
design might have chosen to derive the client application traffic
secret from the transcript digest up to and including the client
Finished.)

Perform the various necessary contortions to construct the client
Finished and to transition to using the application traffic secrets.

With this commit, TLS version 1.3 is functional for the first time.
It is not yet enabled by default, since there are still some missing
features such as session resumption.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 22:47:45 +01:00
Michael Brown 267445294a [tls] Do not schedule sending of unused records in TLS version 1.3
The ClientKeyExchange record does not exist in TLS version 1.3 (since
key exchange happens instead via ClientHello).

The Change Cipher record does not exist in TLS version 1.3, at least
not in the form of something that can be transmitted via the normal
active cipher.

Skip scheduling both of these records for transmission.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 22:42:55 +01:00
Michael Brown ba64f5d2fb [tls] Ignore TLS version 1.3 NewSessionTicket
Session resumption in TLS version 1.3 is structurally different from
TLS version 1.2, and will not initially be supported.

Ignore any NewSessionTicket records for now, since they will otherwise
cause the connection to be aborted.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 22:34:44 +01:00
Michael Brown 78851666b3 [tls] Handle TLS version 1.3 server Finished
When a certificate chain is provided, the TLS version 1.3 server
Finished provides the point at which we can start validating the
certificate chain, equivalent to the ServerHelloDone in TLS version
1.2 and earlier.

The TLS version 1.3 server Finished also provides a convenient point
at which we can calculate the master secret, and defines the point at
which we must schedule the receive cipher to transition to using the
application traffic key.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 22:31:20 +01:00
Michael Brown 8087d6ac22 [tls] Transition to handshake traffic keys after receiving ServerHello
The ServerHello provides the earliest point at which the handshake
traffic keys can be generated, and the defined point at which the
receive cipher must transition to using the handshake traffic key.

We do not intend to support sending early data, and so this also
provides a convenient point at which to transition the tranmit cipher
to using the handshake traffic key.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 22:26:03 +01:00
Michael Brown 9077d45852 [tls] Allow for scheduled traffic phase changes
There are several point within the TLS version 1.3 handshake sequence
at which a handshake message handler needs to transition one or both
ciphers to a new traffic phase, but the new cipher keys cannot be
calculated by the key schedule until the triggering handshake message
has been added to the transcript digest.

Handshake messages are added to the transcript digest only after the
message handler returns, to accommodate the fact that the transcript
digest algorithm cannot be known until the initial ServerHello has
been processed.

Allow a new traffic phase to be recorded in the cipher specification,
which will be activated after the handshake message handlers have
returned.

Changing traffic phase requires changing the cipher in use, and so is
permitted only for the last handshake message in a handshake record.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 22:22:21 +01:00
Michael Brown 7655629db0 [tls] Allow for variable-length verification data
Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 19:57:17 +01:00
Michael Brown c2e9bd951a [tls] Add support for binding via a CertificateVerify record
The format of the signature found within a CertificateVerify is
identical to the format of the signature within a ServerKeyExchange.

Abstract out the logic for verifying a ServerKeyExchange and use it to
verify the signature for both ServerKeyExchange and CertificateVerify.

Note that a CertificateVerify that is erroneously received under TLS
version 1.2 will always fail verification because the key schedule is
not able to generate a signable digest for the server endpoint.

A ServerKeyExchange that is erroneously received under TLS version 1.3
will fail validation because the TLS version 1.3 cipher suites provide
no way to parse the ServerKeyExchange parameters.  (An interestingly
deviant server that chooses to negotiate TLS version 1.3 with a TLS
version 1.2 cipher suite would be able to send a ServerKeyExchange
with a valid signature and have that key contribute accumulatively to
the key schedule: this would not conform to the protocol, but does not
actually weaken any of the security properties required to establish
the secure channel.)

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 18:22:49 +01:00
Michael Brown 14c23c5bb8 [tls] Add support for parsing TLS version 1.3 Certificate record
The TLS version 1.3 Certificate record includes a certificate request
context and an arbitrary list of extensions, both of which we ignore.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 16:23:11 +01:00
Michael Brown d646c92574 [tls] Handle inner plaintext for TLS version 1.3
TLS version 1.3 masquerades as TLS version 1.2 on the wire for the
benefit of badly engineered firewalls and other intermediate devices
that attempt to inspect the protocol stream.

Once a non-plaintext cipher is in use, all records masquerade as
application data, with the unencrypted record comprising the real
record content followed by the real type byte and an arbitrary amount
of zero padding.

Extract the inner plaintext on receive, and create the simplest
possible inner plaintext (with no zero padding) on transmit.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 16:16:46 +01:00
Michael Brown 47b934676a [tls] Allow support for newer TLS versions to be optimised out
The TLS version check already optimises down to a compile-time
constant if the specified version is guaranteed by the configured
minimum supported version.

Extend this check to also take into account the configured maximum
supported version.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 15:51:17 +01:00
Michael Brown 6872d143d6 [tls] Discard received Change Cipher records under TLS version 1.3
TLS version 1.3 allows unencrypted Change Cipher records to be sent
after switching to use the handshake traffic keys.  This is an ugly
protocol hack to work around badly implemented firewalls of the kind
beloved by large organisations.

Ignore and discard any such records, which would otherwise cause
decryption failures.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 13:56:59 +01:00
Michael Brown 4ac73a5cbb [tls] Exclude sequence number from authentication for TLS version 1.3
The authentication header used for TLS version 1.3 no longer includes
the sequence number, since the use of sequential initialisation
vectors renders it redundant.

Skip authenticating this portion of the authentication header for TLS
version 1.3 or later.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 13:56:25 +01:00
Michael Brown 35a1abdbf8 [tls] Allow for sequential cipher initialisation vectors
The CBC ciphers require a fully unpredictable initialisation vector,
which we currently generate as a channel ephemeral secret.  The GCM
ciphers require only a unique initialisation vector: there is no
requirement for it also to be unpredictable.  The content of the
record IV portion of the IV is a free choice of the sender, and we
currently use an unpredictable value for both CBC and GCM.

TLS version 1.3 removes the record IV portion for GCM ciphers, instead
constructing the IV by XORing the sequence number into the end of the
fixed IV.

Define the concept of a sequential initialisation vector as meaning
that the sequence number is XORed into the end of the overall
initialisation vector (which may be either the fixed IV or the record
IV portion), with no per-record unpredictable value required.  This
allows us to represent the mechanism required for TLS version 1.3, and
avoid the unnecessary cost of generating a channel ephemeral secret
for a GCM cipher under TLS version 1.2.

On the receive side, the XORed portion may be overwritten by the real
record IV, since the sender's choice is always definitive for the
contents of the record IV.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 13:55:08 +01:00
Michael Brown 84af36a21b [tls] Limit to TLS version 1.2 in transmitted record headers
TLS version 1.3 masquerades as TLS version 1.2 on the wire for the
benefit of badly engineered firewalls and other intermediate devices
that attempt to inspect the protocol stream.

Limit the maximum version in transmitted record headers to be TLS
version 1.2.  (Continue to accept any version in received record
headers, since this value has never had any significance.)

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 12:29:12 +01:00
Michael Brown 6f1646d7bd [tls] Remove the concept of a pending cipher specification
The cipher specifications are currently modelled as an active cipher
specification that corresponds to the cipher currently in use by the
secure channel abstraction, and a pending cipher specification that
corresponds to the cipher that will be swapped in after the next
ChangeCipherSpec.

This design reflects the wording of RFC 2246 through to RFC 5246:
"there are always four connection states outstanding: the current read
and write states, and the pending read and write states".

This model does not map well to TLS version 1.3, with its multiple
phases of traffic secrets and somewhat idiosyncratic choices of
transcript boundaries.  The client Finished message is a particular
problem: the client application traffic secret must be calculated
after constructing the client Finished verify_data but before adding
the client Finished to the transcript digest (i.e. before encrypting
it with the client handshake traffic keys).  This is an irritating
asymmetry with the server application traffic secret, which may be
calculated cleanly after the server Finished message has been added to
the transcript digest.

Switch to a model in which only the active cipher specification
exists, and always corresponds to the cipher currently in use by the
secure channel abstraction.

Move the record sequence number to become part of the cipher
specification, so that the sequence number reset logic can be shared
between the transmit and receive paths.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-14 00:39:50 +01:00
Michael Brown 76e53bc23f [tls] Add support for the key share extension
RFC 8446 defines the key_share extension as a mechanism for ephemeral
key exchange (replacing ServerKeyExchange and ClientKeyExchange).

Add support for sharing a key in our ClientHello and for parsing the
shared key from a ServerHello.  Construct the ClientHello on the heap
rather than on the stack, since the shared key values may be large
(e.g. for FFDHE4096).

Select the most preferred named group for sending the initial shared
key.  (We do not yet handle a HelloRetryRequest: if the server chooses
a different named group then we will record this group but do not yet
support sending the second ClientHello.)

We do not explicitly reject a key share extension received from a
server that negotiated TLS version 1.2 or lower.  Any such key will be
successfully used to establish a shared secret (and so the secure
channel will become keyed), but there is no way for this shared secret
to subsequently be successfully bound to the server's identity: a
ServerKeyExchange would replace the shared secret (since the TLS
version 1.2 key schedule is not accumulative), and a CertificateVerify
would fail to generate a signable digest.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 16:01:07 +01:00
Michael Brown aaccac9436 [tls] Add ClientHello to transcript before selecting named group
The TLS version 1.3 ClientHello includes a key_share extension whose
value will depend upon the selected key exchange named group.  The
incorporation of the initial ClientHello into the selected handshake
digest must therefore be done before the named group is potentially
modified.

Move responsibility for adding the initial ClientHello to the
transcript digest from tls_new_server_hello() to tls_select_cipher(),
so that this can be done before updating the selected named group.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 15:58:21 +01:00
Michael Brown d703617cc4 [tls] Handle TLS version 1.3 session ID echoing
RFC 8446 redefines the session ID within a TLS version 1.3 ServerHello
as being a field that must always echo the session ID from ClientHello
(and no longer indicates that session resumption is taking place), as
a workaround for badly engineered middleware boxes.

Skip ID-based session resumption if the negotiated version is TLS
version 1.3 or later, and instead abort the connection if the session
ID is not echoed verbatim (as per the RFC).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 15:58:21 +01:00
Michael Brown 744d9e8b56 [tls] Use HKDF-based key schedule for TLS version 1.3 or later
Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 15:58:21 +01:00
Michael Brown 30f0db898a [crypto] Refuse to allow zero-length ServerKeyExchange parameters
The signable digest value is used to bind the server identity to the
shared secret, and so the digest must be computed over the parameters
used to establish the shared secret.

For both endpoints in TLS version 1.3 and for the client endpoint in
TLS version 1.2, the digest is computed over the running transcript
hash and so already includes the parameters used to establish the
shared secret.

For the server endpoint in TLS version 1.2, the digest is computed
over only the client and server random bytes plus any additional data
passed in by the caller, and so this additional data must include the
parameters used to establish the shared secret.

The signable digest value for the server endpoint is currently
computed only in response to a ServerKeyExchange record, in which case
the additional data correctly contains the parameters from that record
that were used to establish the shared secret.

Adding support for TLS version 1.3 will necessitate adding the ability
to parse a received CertificateVerify record, which will attempt to
construct a signable digest value with no additional data.

Require additional data to be provided when constructing a signable
digest value for the server endpoint using the TLS version 1.2 key
schedule, to prevent a CertificateVerify from potentially being used
to verify a digest that was not computed over the parameters used to
establish the shared secret.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 15:58:17 +01:00
Michael Brown 7a3b423f69 [crypto] Ensure TLS signable digests cover a shared secret
The signable digest value is used to bind the server identity to the
shared secret, and so the digest must be computed over the parameters
used to establish the shared secret in order to be meaningful.

The secure channel will refuse to bind the peer identity on the basis
of a verified signable digest if the channel does not already contain
key material derived from a shared secret.

A signable digest that was erroneously constructed before a shared
secret was applied is therefore guaranteed to be unusable for binding
the channel, provided that the caller uses a sensible sequence of
operations (i.e. constructs the signable digest and then immediately
attempts to use it to bind the peer identity).

Strengthen this guarantee further by refusing to generate a signable
digest value unless the key schedule already contains key material.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 15:55:37 +01:00
Michael Brown 356bb14f33 [tls] Detect version downgrade attacks
RFC 8446 defines a mechanism that allows (but does not guarantee) the
detection of version downgrade attacks, based on magic signature
values placed within the ServerHello random bytes.  The magic
signature will be present if the server supports any version higher
than the negotiated version, and so may be present if the server
supports a higher version than we are offering.

The last byte of the magic signature is non-constant and is defined to
match the server's negotiated protocol version, encoded as a delta
from the value 0x0302 representing TLS version 1.1 (or lower).  Since
the server random bytes are always used in the construction of
verify_data (even in older versions of TLS without the extended master
secret), this encoding of the negotiated version cannot be forged by
an attacker.

If the version that is negotiated is lower than the version that we
offered (i.e. if a downgrade attack could possibly be happening), then
check for the range of magic signatures that could indicate a
downgrade attack, and terminate the connection if applicable.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 11:34:35 +01:00
Michael Brown f26cb52f16 [tls] Add support for the supported versions extension
RFC 8446 caps the version number field in ClientHello and ServerHello
to represent at most TLS version 1.2, as a workaround for badly
engineered servers and middleware boxes.  The actual protocol version
is instead negotiated via the supported_versions extension.

Send the list of supported versions in the ClientHello, and parse the
selected version from the supported_version extenion if present in the
ServerHello.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 11:27:04 +01:00
Michael Brown 79df48adae [tls] Add definitions for TLS version 1.3 cipher suites
RFC 8446 redefines the concept of a cipher suite for TLS version 1.3
to exclude the key exchange algorithm, leaving it specifying only the
block cipher algorithm and the handshake digest algorithm.

Add definitions for the two cipher suites that we can currently
support (TLS_AES_128_GCM_SHA256 and TLS_AES_256_GCM_SHA384).

We define these as using the null key exchange algorithm.  The null
key exchange algorithm will fail on any attempt at key agreement.  A
server that attempts to rely on the key exchange algorithm implied by
the cipher suite (e.g. a server attempting to illegally use these
cipher suites with TLS version 1.2) will therefore be unable to
establish a shared secret and so will not be able to cause the secure
channel to become established.

We therefore do not explicitly check for and reject a server's attempt
to negotiate a TLS version 1.3 cipher suite under TLS version 1.2 or
earlier: the secure channel abstraction already ensures that such a
negotiation is doomed to failure.

Under TLS version 1.3, the cipher suite's key exchange algorithm
specification will not be used.  We therefore do not explicitly check
for and reject a server's attempt to negotiate a TLS version 1.2 or
earlier cipher suite under TLS version 1.3 or later: we instead just
ignore the key exchange algorithm aspect of that cipher suite.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 11:26:40 +01:00
Michael Brown dbdbaa871c [tls] Record named group rather than key exchange algorithm
The concept of a named group is currently relevant only at the point
of parsing a ServerKeyExchange record to determine the key exchange
algorithm: once parsed, the group's numeric code is no longer required
and so we currently record only the resulting key exchange algorithm.

For TLS version 1.3, the numeric code will also be needed when
constructing the key_share extension in the ClientHello.

Switch from recording the key exchange algorithm to recording the
functionally equivalent named group, thereby making it possible to
retrieve the numeric code when needed.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-13 00:27:50 +01:00
Michael Brown ff6e52063e [crypto] Add AES acceleration using the Arm Cryptographic Extensions
Implement AES hardware acceleration for AArch64 using the AES subset
of the Cryptographic Extensions.  All supported runtime environments
already allow for use of the SIMD/FP registers, and so the only
required compiler quirk is to annotate the functions as being
permitted to emit the AES instructions.

Feature detection relies upon the ability to read the ID_AA64ISAR0_EL1
system register.  This works as expected in all supported runtime
environments:

  - As a UEFI binary, we are running in a real EL1 and so can just
    read the system register for the current (and only active) core

  - As a Linux userspace binary running in EL0, the kernel (since
    4.11) will emulate the read to report the subset of features that
    are supported by all online cores

  - As a Linux userspace binary run via QEMU's binary translation,
    QEMU (since 4.0.0) will similarly emulate the read to report the
    features supported by the selected CPU model

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-07 15:14:39 +01:00
Michael Brown 0214e4391a [crypto] Add support for AES-NI hardware acceleration
Implement AES hardware acceleration for i386 and x86_64, using the
AES-NI instructions (and the SSE2 "pxor" instruction for the initial
AddRoundKey), using the unmodified existing key schedule as generated
by aes_setkey().

For raw AES (ignoring the block cipher mode of operation), this
results in a speed improvement from approximately 20 cycles per byte
down to approximately 1 cycle per byte.

The AES-NI instructions use SSE registers.  For the sake of not having
to think about the possible consequences across all various runtime
environments (BIOS/UEFI/Linux), we choose not to enable "-msse" in
CFLAGS for this file.  We include ".arch" directives to ensure that
the assembler knows that it is permitted to emit the SSE2 and AES-NI
instructions, use a fixed "%xmm0" rather than an "x" constraint (which
GCC would consider to be impossible without "-msse"), and restore the
value of "%xmm0" after use to meet the requirements of the most
restrictive ABI for which this file can be built.

In an ideal world, we would also use a ".arch push" / ".arch pop" pair
to restore the permitted instruction set, rather than leaving the SSE2
and AES-NI instructions as permitted outside the scope of the inline
asm.  Unfortunately this feature would require binutils 2.34 or newer,
and so would prevent building iPXE on some still-current distros such
as RHEL8.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 23:47:24 +01:00
Michael Brown 7ada3e0f04 [crypto] Align AES round keys within the AES context
Some AES hardware acceleration instructions require each 16-byte round
key to be aligned on a 16-byte boundary.  Cipher contexts are byte
arrays allocated by the caller and do not have any guaranteed
alignment.

Increase the AES context size to allow space for alignment padding,
and align the context before use.  Reduce the round count field from
an unsigned int to a uint8_t, to minimise wasted space and to ensure
that the resulting padded context size is itself reasonably aligned.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 19:46:31 +01:00
Michael Brown c4023b98e3 [crypto] Allow for AES hardware acceleration
Allow architectures to detect support for AES hardware acceleration at
runtime and to replace the AES algorithm's encrypt() and decrypt()
method pointers with hardware accelerated implementations.

Extend the automated tests to run the AES tests twice: once with
hardware acceleration explicitly disabled (to test the unaccelerated
software implementation) and once with acceleration re-enabled.  Skip
the second test if no hardware acceleration is available: this avoids
unnecessarily repeating the test of the unaccelerated implementation,
and allows a non-zero test count for "aes-hw" to indicate that the
hardware acceleration was tested.  For example:

On a system that supports AES hardware acceleration:

   OK: "aes" 120 tests passed
   OK: "aes-hw" 120 tests passed

On a system that does not support AES hardware acceleration:

   OK: "aes" 120 tests passed
   OK: "aes-hw" 0 tests passed

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 19:46:31 +01:00
Michael Brown d916dfcfae [librm] Enable the use of SSE instructions if supported by the CPU
Clear CR0.EM, clear CR0.TS, and set CR4.OSFXSR in order to allow the
execution of SSE instructions such as the AES-NI instructions for AES
hardware acceleration.

Note that we have to assert CR4.OSFXSR to allow these instructions to
execute, but our context switching logic (e.g. the protected-mode and
long-mode interrupt handlers) does not actually preserve the
FPU/MMX/SSE registers.

Our C code therefore cannot in general presume that the FPU/MMX/SSE
registers will be preserved across arbitrary context boundaries.
However, since C code executes with interrupts disabled, an individual
function may safely use temporary FPU/MMX/SSE registers provided that
it does not enable interrupts or otherwise relinquish the context.

For the same C code to also be usable under the UEFI IA-32 ABI, it
must preserve all registers other than %eax, %ecx, and %edx, including
preserving all MMX and XMM registers.

The practical upshot is therefore that C code may use SSE instructions
and may assume that SSE registers will not be changed arbitrarily
during execution (either because the ABI guarantees preservation, as
with UEFI or Linux, or because the runtime environment guarantees that
interrupts are disabled), but the C code must itself restore the
values of any modified FPU/MMX/SSE registers.

The "fxsave"/"fxrstor" performed by virt_call() would allow for a
slightly more relaxed constraint if support for the UEFI IA-32 ABI
were ever to be dropped in future.  A real-mode caller that is making
use of SSE must have already set OSFXSR, and so its non-64-bit
registers %xmm0-%xmm7 would already be saved and restored across
virt_call().  The tightest constraint would then become the UEFI X64
ABI, which defines %xmm0-%xmm5 as volatile (i.e. caller-saved): this
would allow C code in iPXE to use %xmm0-%xmm5 without needing to
explicitly save and restore their values.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 19:43:49 +01:00
Michael Brown f5828201ea [librm] Preserve CR0 across virt_call()
Clearing the CR0.EM and CR0.TS flags is a prerequisite for using the
AES-NI instructions for AES hardware acceleration: if CR0.EM is set
then the CPU will raise an undefined-instruction exception, and if
CR0.TS is set then the CPU will raise a device-not-available exception
(expecting the OS to have installed an exception handler that would
perform a deferred context switch of the FPU/MMX/SSE registers).

Preserve CR0 across virt_call(), to allow the CR0.EM and CR0.TS flags
to be modified as needed.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 15:13:38 +01:00
Michael Brown a69ad34217 [librm] Preserve CR4 across virt_call() if FXSR is supported
Setting the CR4.OSFXSR flag is a prerequisite for using the AES-NI
instructions for AES hardware acceleration: if this flag is not set
then the CPU will raise an undefined-instruction exception.

We currently preserve CR4 across virt_call() only for 64-bit builds,
since those will modify CR4 by setting CR4.PAE.  Extend this to
preserve CR4 across virt_call() if FXSR is supported, to allow the
CR4.OSFXSR flag to be modified as needed.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 15:13:38 +01:00
Michael Brown 8f334fd55d [librm] Skip runtime check for FXSR support in 64-bit builds
SSE is an architectural requirement for x86_64, and FXSR is an
architectural requirement for SSE.  We can therefore skip the FXSR
check in a 64-bit build, since no 64-bit CPU can exist that does not
advertise support for FXSR.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 15:13:38 +01:00
Michael Brown af9604576d [librm] Remove conditionalisation of the Tivoli VMM workaround
Commit 71560d1 ("[librm] Preserve FPU, MMX and SSE state across calls
to virt_call()") originally introduced the use of "fxsave" and
"fxrstor" to work around a bug in the implementation of memcpy()
within the IBM Tivoli Provisioning Manager's VMM.  This commit assumed
(with justification given in the commit message) that SSE support
could be assumed to be present on any realistic in-scope CPU, and so
these instructions may safely be assumed to be supported.

Commit dd9a14d ("[librm] Conditionalize the workaround for the Tivoli
VMM's SSE garbling") then made this workaround a compile-time
conditional, to work around a missing feature in QEMU that caused the
use of "fxsave" and "fxrstor" to fail in QEMU VMs on some host CPUs.

Commit 900f1f9 ("[librm] Test for FXSAVE/FXRSTOR instruction support")
then added a runtime CPUID check for the FXSR feature, to allow the
unmodified iPXE binary to be used on older CPUs.

Supporting AES hardware acceleration via AES-NI will require setting
the CR4.OSFXSR control bit, which in turn must be conditionalised upon
the same runtime CPUID check for the FXSR feature.

Perform the runtime check unconditionally, and assume that we no
longer need the compile-time conditional (i.e. assume either that
newer versions of QEMU emulate "fxsave" and "fxrstor" when needed, or
that QEMU reports via CPUID that FXSR is not supported if it cannot
support those instructions).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 15:13:38 +01:00
Michael Brown aef505b823 [librm] Clarify layout of saved GDTR/IDTR
The separate VC_TMP_GDT and VC_TMP_IDT fields suggest that these could
be moved freely relative to each other.  This is not the case: callers
of prot_to_real() must pass a single pointer to the combined pair.

Collapse to a single field, with the name adjusted to VC_TMP_GDTR_IDTR
to more closely match the rm_default_gdtr_idtr structure that
necessarily shares the same layout.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 15:13:38 +01:00
Michael Brown b57bc764a5 [librm] Always disable paging when switching to protected mode
Commit 6143057 ("[librm] Add support for running in 64-bit long mode")
treated disabling paging on the transition into protected mode as
something that needed to be done as a precaution only in a 64-bit
build, on the assumption that in a 32-bit BIOS system nothing else
would be enabling paging.

The Intel SDM states that setting CR0.PG in real mode (with CR0.PE
clear) will raise a general-protection exception anyway, and so we
should never encounter a situation in which CR0.PG is set at this
point.  A review of the bochs source code suggests that it may be
possible to encounter the combination of CR0.PG set with CR0.PE clear
in an SVM guest.

Err on the side of paranoia and always disable paging as part of the
transition from real mode to protected mode.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-06 15:13:38 +01:00
Michael Brown 787ed9397e [crypto] Treat high tag numbers as invalid
ASN.1 allows for multi-byte tag numbers by setting the low five bits
of the first tag byte to 0x1f.  No tag that we need to handle has this
format, and the existing checks for specific tag numbers will already
fail to match against such a tag (treating it as a normal single-byte
tag number).

Refuse to parse any tag with a high tag number format, to guard
against future bugs that could arise because the tag length would be
calculated incorrectly.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 22:42:40 +01:00
Michael Brown d89765d5f0 [test] Add Project Wycheproof RSA-PSS signature verification tests
Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 21:48:48 +01:00
Michael Brown 20613766c9 [test] Add a build target for slow self-tests
The Project Wycheproof self-tests are deliberately not included in the
normal per-commit test suite since they are extremely slow to run.

Add a build target that includes the slow self-tests, and run these
tests on a push to the "slowtest" branch.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 18:32:39 +01:00
Michael Brown 6935ca31e0 [test] Add Project Wycheproof ECDSA signature verification tests
Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 16:55:41 +01:00
Michael Brown 1901e32240 [crypto] Reject non-canonical ECDSA signature encodings
As detailed in commit 511dfd2 ("[crypto] Reject non-canonical ECDSA
signature data structures"), changing the representation of a valid
ECDSA signature to a different valid representation of the same
signature does not conceptually make it an invalid signature.

However, some large public test vector sets conflate the concepts of
"altered representation" and "invalid representation" in a way that
makes it difficult to determine which tests ought to pass and which
ought to fail without extensive manual analysis.

Reject any ECDSA signature object that does not have the expected
total length.  The signature parsing logic already ensures that the
expected structure exists, and so the total length can be correct only
if every object used the expected DER encoding.

This length check completely subsumes the checks that were introduced
in commit 511dfd2 ("[crypto] Reject non-canonical ECDSA signature data
structures"), since there is no way to insert additional information
without also affecting the length.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 16:51:54 +01:00
Michael Brown 3a62e9ded4 [crypto] Reject indefinite and unrepresentable length encodings
An indefinite length encoding will currently be parsed as having a
length of zero, and an encoded length that exceeds the range of an
unsigned int will be truncated.

Tighten up the parsing of lengths to explicitly reject indefinite
length encodings or unrepresentable lengths.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 16:51:54 +01:00
Michael Brown de04e79ae5 [crypto] Reject ASN.1 unsigned integers holding negative values
We use asn1_enter_unsigned() essentially as a convenience mechanism to
skip the initial zero byte found when an encoder had to insert the
zero to prevent a logically unsigned value from being interpreted as
negative.

We currently accept malformed values where the initial byte has the
MSB set, and allow them to be interpreted as unsigned values.

Tighten up the parsing of unsigned integers so that values where the
initial byte has the MSB set will be rejected as invalid, and ensure
that the resulting cursor is minimal by skipping any number of initial
padding zero bytes (so that asn1_compare() can then be used without
the risk of false negatives).

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 14:28:27 +01:00
Michael Brown 511dfd2c4d [crypto] Reject non-canonical ECDSA signature data structures
An ECDSA signature value is a vector of two integers (r,s) modulo the
curve group order.  The ECDSA algorithm itself does not define the
encoding to be used for these two integers.  At least two different
standards exist for representing the vector (r,s): the ASN.1 structure
originally defined in RFC 3279 (which uses a SEQUENCE of two INTEGER
values) and the raw byte concatenation structure defined in IEEE
P1363.  A valid signature vector (r,s) may be freely converted between
these two formats.  Changing the format does not logically change the
validity of the signature.

Due to the mathematics underlying ECDSA, the vector (r,-s) is also
always a valid signature for the same content.

With the ASN.1 structure, there exists the possibility of adding extra
data that would currently be ignored by the parser: either objects
following the top-level SEQUENCE, or objects within the SEQUENCE
following the two INTEGER values.  Adding this data does not logically
change the validity of the signature, in the same way that converting
between ASN.1 and P1363 does not logically change the validity of the
signature.  However, some public test vector sets check for the
rejection of signatures containing inserted data.

Reject any ECDSA signature object that includes data following the
top-level SEQUENCE, or that includes data following the "r" and "s"
INTEGER values.

Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-04 13:43:05 +01:00
Michael Brown 0a1d5fae46 [test] Simplify class hierarchy for Project Wycheproof import tool
Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-03 14:14:15 +01:00
Michael Brown 2d2dd525bd [test] Derive comment labels from Project Wycheproof input files
Signed-off-by: Michael Brown <mcb30@ipxe.org>
2026-09-03 13:15:44 +01:00