dhm.c 14.1 KB
Newer Older
1 2 3
/*
 *  Diffie-Hellman-Merkle key exchange
 *
Manuel Pégourié-Gonnard's avatar
Manuel Pégourié-Gonnard committed
4
 *  Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
Paul Bakker's avatar
Paul Bakker committed
5
 *
6
 *  This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker's avatar
Paul Bakker committed
7
 *
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
/*
 *  Reference:
 *
 *  http://www.cacr.math.uwaterloo.ca/hac/ (chapter 12)
 */

28
#if !defined(POLARSSL_CONFIG_FILE)
29
#include "polarssl/config.h"
30 31 32
#else
#include POLARSSL_CONFIG_FILE
#endif
33

34
#if defined(POLARSSL_DHM_C)
35

36
#include "polarssl/dhm.h"
37

38 39
#include <string.h>

40
#if defined(POLARSSL_PEM_PARSE_C)
41 42 43 44 45 46 47
#include "polarssl/pem.h"
#endif

#if defined(POLARSSL_ASN1_PARSE_C)
#include "polarssl/asn1.h"
#endif

48 49
#if defined(POLARSSL_PLATFORM_C)
#include "polarssl/platform.h"
50 51
#else
#include <stdlib.h>
52
#include <stdio.h>
53
#define polarssl_printf     printf
54 55 56 57
#define polarssl_malloc     malloc
#define polarssl_free       free
#endif

58 59 60 61 62
/* Implementation that should never be optimized out by the compiler */
static void polarssl_zeroize( void *v, size_t n ) {
    volatile unsigned char *p = v; while( n-- ) *p++ = 0;
}

63 64 65 66 67
/*
 * helper to validate the mpi size and import it
 */
static int dhm_read_bignum( mpi *X,
                            unsigned char **p,
68
                            const unsigned char *end )
69 70 71 72
{
    int ret, n;

    if( end - *p < 2 )
73
        return( POLARSSL_ERR_DHM_BAD_INPUT_DATA );
74 75 76 77 78

    n = ( (*p)[0] << 8 ) | (*p)[1];
    (*p) += 2;

    if( (int)( end - *p ) < n )
79
        return( POLARSSL_ERR_DHM_BAD_INPUT_DATA );
80 81

    if( ( ret = mpi_read_binary( X, *p, n ) ) != 0 )
82
        return( POLARSSL_ERR_DHM_READ_PARAMS_FAILED + ret );
83 84 85 86 87 88

    (*p) += n;

    return( 0 );
}

Paul Bakker's avatar
Paul Bakker committed
89
/*
90
 * Verify sanity of parameter with regards to P
91
 *
92
 * Parameter should be: 2 <= public_param <= P - 2
93 94 95 96
 *
 * For more information on the attack, see:
 *  http://www.cl.cam.ac.uk/~rja14/Papers/psandqs.pdf
 *  http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2005-2643
Paul Bakker's avatar
Paul Bakker committed
97
 */
98
static int dhm_check_range( const mpi *param, const mpi *P )
Paul Bakker's avatar
Paul Bakker committed
99
{
100 101
    mpi L, U;
    int ret = POLARSSL_ERR_DHM_BAD_INPUT_DATA;
Paul Bakker's avatar
Paul Bakker committed
102

103
    mpi_init( &L ); mpi_init( &U );
104 105 106

    MPI_CHK( mpi_lset( &L, 2 ) );
    MPI_CHK( mpi_sub_int( &U, P, 2 ) );
Paul Bakker's avatar
Paul Bakker committed
107

108 109
    if( mpi_cmp_mpi( param, &L ) >= 0 &&
        mpi_cmp_mpi( param, &U ) <= 0 )
Paul Bakker's avatar
Paul Bakker committed
110
    {
111
        ret = 0;
Paul Bakker's avatar
Paul Bakker committed
112 113
    }

114
cleanup:
115
    mpi_free( &L ); mpi_free( &U );
116
    return( ret );
Paul Bakker's avatar
Paul Bakker committed
117 118
}

Paul Bakker's avatar
Paul Bakker committed
119 120 121 122 123
void dhm_init( dhm_context *ctx )
{
    memset( ctx, 0, sizeof( dhm_context ) );
}

124 125 126 127 128
/*
 * Parse the ServerKeyExchange parameters
 */
int dhm_read_params( dhm_context *ctx,
                     unsigned char **p,
129
                     const unsigned char *end )
130
{
Paul Bakker's avatar
Paul Bakker committed
131
    int ret;
132 133 134 135 136 137

    if( ( ret = dhm_read_bignum( &ctx->P,  p, end ) ) != 0 ||
        ( ret = dhm_read_bignum( &ctx->G,  p, end ) ) != 0 ||
        ( ret = dhm_read_bignum( &ctx->GY, p, end ) ) != 0 )
        return( ret );

138 139 140
    if( ( ret = dhm_check_range( &ctx->GY, &ctx->P ) ) != 0 )
        return( ret );

141 142 143 144 145 146 147 148 149
    ctx->len = mpi_size( &ctx->P );

    return( 0 );
}

/*
 * Setup and write the ServerKeyExchange parameters
 */
int dhm_make_params( dhm_context *ctx, int x_size,
150
                     unsigned char *output, size_t *olen,
151 152
                     int (*f_rng)(void *, unsigned char *, size_t),
                     void *p_rng )
153
{
154
    int ret, count = 0;
155
    size_t n1, n2, n3;
156 157
    unsigned char *p;

158 159 160
    if( mpi_cmp_int( &ctx->P, 0 ) == 0 )
        return( POLARSSL_ERR_DHM_BAD_INPUT_DATA );

161
    /*
162
     * Generate X as large as possible ( < P )
163
     */
164 165 166
    do
    {
        mpi_fill_random( &ctx->X, x_size, f_rng, p_rng );
167

168
        while( mpi_cmp_mpi( &ctx->X, &ctx->P ) >= 0 )
169
            MPI_CHK( mpi_shift_r( &ctx->X, 1 ) );
170 171 172 173 174

        if( count++ > 10 )
            return( POLARSSL_ERR_DHM_MAKE_PARAMS_FAILED );
    }
    while( dhm_check_range( &ctx->X, &ctx->P ) != 0 );
175

176 177 178
    /*
     * Calculate GX = G^X mod P
     */
179 180 181
    MPI_CHK( mpi_exp_mod( &ctx->GX, &ctx->G, &ctx->X,
                          &ctx->P , &ctx->RP ) );

182
    if( ( ret = dhm_check_range( &ctx->GX, &ctx->P ) ) != 0 )
Paul Bakker's avatar
Paul Bakker committed
183 184
        return( ret );

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    /*
     * export P, G, GX
     */
#define DHM_MPI_EXPORT(X,n)                     \
    MPI_CHK( mpi_write_binary( X, p + 2, n ) ); \
    *p++ = (unsigned char)( n >> 8 );           \
    *p++ = (unsigned char)( n      ); p += n;

    n1 = mpi_size( &ctx->P  );
    n2 = mpi_size( &ctx->G  );
    n3 = mpi_size( &ctx->GX );

    p = output;
    DHM_MPI_EXPORT( &ctx->P , n1 );
    DHM_MPI_EXPORT( &ctx->G , n2 );
    DHM_MPI_EXPORT( &ctx->GX, n3 );

    *olen  = p - output;

    ctx->len = n1;

cleanup:

    if( ret != 0 )
209
        return( POLARSSL_ERR_DHM_MAKE_PARAMS_FAILED + ret );
210 211 212 213 214 215 216 217

    return( 0 );
}

/*
 * Import the peer's public value G^Y
 */
int dhm_read_public( dhm_context *ctx,
218
                     const unsigned char *input, size_t ilen )
219 220 221 222
{
    int ret;

    if( ctx == NULL || ilen < 1 || ilen > ctx->len )
223
        return( POLARSSL_ERR_DHM_BAD_INPUT_DATA );
224 225

    if( ( ret = mpi_read_binary( &ctx->GY, input, ilen ) ) != 0 )
226
        return( POLARSSL_ERR_DHM_READ_PUBLIC_FAILED + ret );
227 228 229 230 231 232 233 234

    return( 0 );
}

/*
 * Create own private value X and export G^X
 */
int dhm_make_public( dhm_context *ctx, int x_size,
235
                     unsigned char *output, size_t olen,
236 237
                     int (*f_rng)(void *, unsigned char *, size_t),
                     void *p_rng )
238
{
239
    int ret, count = 0;
240 241

    if( ctx == NULL || olen < 1 || olen > ctx->len )
242
        return( POLARSSL_ERR_DHM_BAD_INPUT_DATA );
243

244 245 246
    if( mpi_cmp_int( &ctx->P, 0 ) == 0 )
        return( POLARSSL_ERR_DHM_BAD_INPUT_DATA );

247 248 249
    /*
     * generate X and calculate GX = G^X mod P
     */
250 251 252
    do
    {
        mpi_fill_random( &ctx->X, x_size, f_rng, p_rng );
253

254
        while( mpi_cmp_mpi( &ctx->X, &ctx->P ) >= 0 )
255
            MPI_CHK( mpi_shift_r( &ctx->X, 1 ) );
256 257 258 259 260

        if( count++ > 10 )
            return( POLARSSL_ERR_DHM_MAKE_PUBLIC_FAILED );
    }
    while( dhm_check_range( &ctx->X, &ctx->P ) != 0 );
261 262 263 264

    MPI_CHK( mpi_exp_mod( &ctx->GX, &ctx->G, &ctx->X,
                          &ctx->P , &ctx->RP ) );

265 266
    if( ( ret = dhm_check_range( &ctx->GX, &ctx->P ) ) != 0 )
        return( ret );
Paul Bakker's avatar
Paul Bakker committed
267

268 269 270 271 272
    MPI_CHK( mpi_write_binary( &ctx->GX, output, olen ) );

cleanup:

    if( ret != 0 )
273
        return( POLARSSL_ERR_DHM_MAKE_PUBLIC_FAILED + ret );
274 275 276 277

    return( 0 );
}

278 279 280 281 282 283 284 285 286 287 288 289
/*
 * Use the blinding method and optimisation suggested in section 10 of:
 *  KOCHER, Paul C. Timing attacks on implementations of Diffie-Hellman, RSA,
 *  DSS, and other systems. In : Advances in Cryptology—CRYPTO’96. Springer
 *  Berlin Heidelberg, 1996. p. 104-113.
 */
static int dhm_update_blinding( dhm_context *ctx,
                    int (*f_rng)(void *, unsigned char *, size_t), void *p_rng )
{
    int ret, count;

    /*
290 291
     * Don't use any blinding the first time a particular X is used,
     * but remember it to use blinding next time.
292
     */
293
    if( mpi_cmp_mpi( &ctx->X, &ctx->pX ) != 0 )
294
    {
295
        MPI_CHK( mpi_copy( &ctx->pX, &ctx->X ) );
296 297 298 299
        MPI_CHK( mpi_lset( &ctx->Vi, 1 ) );
        MPI_CHK( mpi_lset( &ctx->Vf, 1 ) );

        return( 0 );
300 301 302
    }

    /*
303 304
     * Ok, we need blinding. Can we re-use existing values?
     * If yes, just update them by squaring them.
305
     */
306
    if( mpi_cmp_int( &ctx->Vi, 1 ) != 0 )
307
    {
308 309 310
        MPI_CHK( mpi_mul_mpi( &ctx->Vi, &ctx->Vi, &ctx->Vi ) );
        MPI_CHK( mpi_mod_mpi( &ctx->Vi, &ctx->Vi, &ctx->P ) );

311 312
        MPI_CHK( mpi_mul_mpi( &ctx->Vf, &ctx->Vf, &ctx->Vf ) );
        MPI_CHK( mpi_mod_mpi( &ctx->Vf, &ctx->Vf, &ctx->P ) );
313

314
        return( 0 );
315
    }
316 317

    /*
318
     * We need to generate blinding values from scratch
319
     */
320

321 322 323 324 325 326 327
    /* Vi = random( 2, P-1 ) */
    count = 0;
    do
    {
        mpi_fill_random( &ctx->Vi, mpi_size( &ctx->P ), f_rng, p_rng );

        while( mpi_cmp_mpi( &ctx->Vi, &ctx->P ) >= 0 )
328
            MPI_CHK( mpi_shift_r( &ctx->Vi, 1 ) );
329 330 331 332 333 334

        if( count++ > 10 )
            return( POLARSSL_ERR_MPI_NOT_ACCEPTABLE );
    }
    while( mpi_cmp_int( &ctx->Vi, 1 ) <= 0 );

335 336 337 338 339 340 341 342
    /* Vf = Vi^-X mod P */
    MPI_CHK( mpi_inv_mod( &ctx->Vf, &ctx->Vi, &ctx->P ) );
    MPI_CHK( mpi_exp_mod( &ctx->Vf, &ctx->Vf, &ctx->X, &ctx->P, &ctx->RP ) );

cleanup:
    return( ret );
}

343 344 345 346
/*
 * Derive and export the shared secret (G^Y)^X mod P
 */
int dhm_calc_secret( dhm_context *ctx,
347 348 349
                     unsigned char *output, size_t *olen,
                     int (*f_rng)(void *, unsigned char *, size_t),
                     void *p_rng )
350 351
{
    int ret;
352
    mpi GYb;
353

354
    if( ctx == NULL || *olen < ctx->len )
355
        return( POLARSSL_ERR_DHM_BAD_INPUT_DATA );
356

357
    if( ( ret = dhm_check_range( &ctx->GY, &ctx->P ) ) != 0 )
Paul Bakker's avatar
Paul Bakker committed
358 359
        return( ret );

360 361 362
    mpi_init( &GYb );

    /* Blind peer's value */
363
    if( f_rng != NULL )
364 365 366 367 368 369 370 371 372 373 374 375 376
    {
        MPI_CHK( dhm_update_blinding( ctx, f_rng, p_rng ) );
        MPI_CHK( mpi_mul_mpi( &GYb, &ctx->GY, &ctx->Vi ) );
        MPI_CHK( mpi_mod_mpi( &GYb, &GYb, &ctx->P ) );
    }
    else
        MPI_CHK( mpi_copy( &GYb, &ctx->GY ) );

    /* Do modular exponentiation */
    MPI_CHK( mpi_exp_mod( &ctx->K, &GYb, &ctx->X,
                          &ctx->P, &ctx->RP ) );

    /* Unblind secret value */
377
    if( f_rng != NULL )
378 379 380 381 382
    {
        MPI_CHK( mpi_mul_mpi( &ctx->K, &ctx->K, &ctx->Vf ) );
        MPI_CHK( mpi_mod_mpi( &ctx->K, &ctx->K, &ctx->P ) );
    }

383 384 385 386 387
    *olen = mpi_size( &ctx->K );

    MPI_CHK( mpi_write_binary( &ctx->K, output, *olen ) );

cleanup:
388
    mpi_free( &GYb );
389 390

    if( ret != 0 )
391
        return( POLARSSL_ERR_DHM_CALC_SECRET_FAILED + ret );
392 393 394 395 396 397 398 399 400

    return( 0 );
}

/*
 * Free the components of a DHM key
 */
void dhm_free( dhm_context *ctx )
{
401
    mpi_free( &ctx->pX); mpi_free( &ctx->Vf ); mpi_free( &ctx->Vi );
402 403 404
    mpi_free( &ctx->RP ); mpi_free( &ctx->K ); mpi_free( &ctx->GY );
    mpi_free( &ctx->GX ); mpi_free( &ctx->X ); mpi_free( &ctx->G );
    mpi_free( &ctx->P );
405

406
    polarssl_zeroize( ctx, sizeof( dhm_context ) );
407 408
}

409 410 411 412
#if defined(POLARSSL_ASN1_PARSE_C)
/*
 * Parse DHM parameters
 */
413 414
int dhm_parse_dhm( dhm_context *dhm, const unsigned char *dhmin,
                   size_t dhminlen )
415 416 417 418
{
    int ret;
    size_t len;
    unsigned char *p, *end;
419
#if defined(POLARSSL_PEM_PARSE_C)
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
    pem_context pem;

    pem_init( &pem );

    ret = pem_read_buffer( &pem,
                           "-----BEGIN DH PARAMETERS-----",
                           "-----END DH PARAMETERS-----",
                           dhmin, NULL, 0, &dhminlen );

    if( ret == 0 )
    {
        /*
         * Was PEM encoded
         */
        dhminlen = pem.buflen;
    }
    else if( ret != POLARSSL_ERR_PEM_NO_HEADER_FOOTER_PRESENT )
        goto exit;

    p = ( ret == 0 ) ? pem.buf : (unsigned char *) dhmin;
#else
    p = (unsigned char *) dhmin;
442
#endif /* POLARSSL_PEM_PARSE_C */
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
    end = p + dhminlen;

    /*
     *  DHParams ::= SEQUENCE {
     *      prime            INTEGER,  -- P
     *      generator        INTEGER,  -- g
     *  }
     */
    if( ( ret = asn1_get_tag( &p, end, &len,
            ASN1_CONSTRUCTED | ASN1_SEQUENCE ) ) != 0 )
    {
        ret = POLARSSL_ERR_DHM_INVALID_FORMAT + ret;
        goto exit;
    }

    end = p + len;

    if( ( ret = asn1_get_mpi( &p, end, &dhm->P  ) ) != 0 ||
        ( ret = asn1_get_mpi( &p, end, &dhm->G ) ) != 0 )
    {
        ret = POLARSSL_ERR_DHM_INVALID_FORMAT + ret;
        goto exit;
    }

    if( p != end )
    {
        ret = POLARSSL_ERR_DHM_INVALID_FORMAT +
              POLARSSL_ERR_ASN1_LENGTH_MISMATCH;
        goto exit;
    }

    ret = 0;

476 477
    dhm->len = mpi_size( &dhm->P );

478
exit:
479
#if defined(POLARSSL_PEM_PARSE_C)
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
    pem_free( &pem );
#endif
    if( ret != 0 )
        dhm_free( dhm );

    return( ret );
}

#if defined(POLARSSL_FS_IO)
/*
 * Load all data from a file into a given buffer.
 */
static int load_file( const char *path, unsigned char **buf, size_t *n )
{
    FILE *f;
    long size;

    if( ( f = fopen( path, "rb" ) ) == NULL )
        return( POLARSSL_ERR_DHM_FILE_IO_ERROR );

    fseek( f, 0, SEEK_END );
    if( ( size = ftell( f ) ) == -1 )
    {
        fclose( f );
        return( POLARSSL_ERR_DHM_FILE_IO_ERROR );
    }
    fseek( f, 0, SEEK_SET );

    *n = (size_t) size;

    if( *n + 1 == 0 ||
511
        ( *buf = polarssl_malloc( *n + 1 ) ) == NULL )
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
    {
        fclose( f );
        return( POLARSSL_ERR_DHM_MALLOC_FAILED );
    }

    if( fread( *buf, 1, *n, f ) != *n )
    {
        fclose( f );
        polarssl_free( *buf );
        return( POLARSSL_ERR_DHM_FILE_IO_ERROR );
    }

    fclose( f );

    (*buf)[*n] = '\0';

    return( 0 );
}

/*
 * Load and parse DHM parameters
 */
int dhm_parse_dhmfile( dhm_context *dhm, const char *path )
{
    int ret;
    size_t n;
    unsigned char *buf;

540
    if( ( ret = load_file( path, &buf, &n ) ) != 0 )
541 542 543 544
        return( ret );

    ret = dhm_parse_dhm( dhm, buf, n );

545
    polarssl_zeroize( buf, n + 1 );
546 547 548 549 550 551 552
    polarssl_free( buf );

    return( ret );
}
#endif /* POLARSSL_FS_IO */
#endif /* POLARSSL_ASN1_PARSE_C */

553
#if defined(POLARSSL_SELF_TEST)
554

555 556
#include "polarssl/certs.h"

557 558 559 560 561
/*
 * Checkup routine
 */
int dhm_self_test( int verbose )
{
562 563 564 565
#if defined(POLARSSL_CERTS_C)
    int ret;
    dhm_context dhm;

Paul Bakker's avatar
Paul Bakker committed
566 567
    dhm_init( &dhm );

568
    if( verbose != 0 )
569
        polarssl_printf( "  DHM parameter load: " );
570 571 572 573 574

    if( ( ret = dhm_parse_dhm( &dhm, (const unsigned char *) test_dhm_params,
                               strlen( test_dhm_params ) ) ) != 0 )
    {
        if( verbose != 0 )
575
            polarssl_printf( "failed\n" );
576

577
        ret = 1;
Paul Bakker's avatar
Paul Bakker committed
578
        goto exit;
579 580 581
    }

    if( verbose != 0 )
582
        polarssl_printf( "passed\n\n" );
583

Paul Bakker's avatar
Paul Bakker committed
584
exit:
585 586
    dhm_free( &dhm );

Paul Bakker's avatar
Paul Bakker committed
587
    return( ret );
588
#else
589 590 591 592
    if( verbose != 0 )
        polarssl_printf( "  DHM parameter load: skipped\n" );

    return( 0 );
593
#endif /* POLARSSL_CERTS_C */
594 595
}

596
#endif /* POLARSSL_SELF_TEST */
597

598
#endif /* POLARSSL_DHM_C */