transform.c

   1 /* Transform module - bulk data transformation */
   2
   3 /* For now it's hard-coded to do sequence
   4    number/pkcs5/serpent-cbcmac/serpent with a 256 bit key for each
   5    instance of serpent. We also require key material for the IVs for
   6    cbcmac and cbc. Hack: we're not using full 128-bit IVs, we're just
   7    using 32 bits and encrypting to get the full IV to save space in
   8    the packets sent over the wire. */
   9
  10 #include <stdio.h>
  11 #include <string.h>
  12 #include "secnet.h"
  13 #include "util.h"
  14 #include "serpent.h"
  15 #include "unaligned.h"
  16
  17 /* Required key length in bytes */
  18 #define REQUIRED_KEYLEN ((512+64+32)/8)
  19
  20 #ifdef WORDS_BIGENDIAN
  21 static inline uint32_t byteswap(uint32_t a)
  22 {
  23     return
  24         ((a&0x000000ff)<<24) |
  25         ((a&0x0000ff00)<<8) |
  26         ((a&0x00ff0000)>>8) |
  27         ((a&0xff000000)>>24);
  28 }
  29 #endif
  30
  31 struct transform {
  32     closure_t cl;
  33     uint32_t line;
  34     struct transform_if ops;
  35     uint32_t max_seq_skew;
  36 };
  37
  38 struct transform_inst {
  39     struct transform_inst_if ops;
  40     struct keyInstance cryptkey;
  41     struct keyInstance mackey;
  42     uint32_t cryptiv;
  43     uint32_t maciv;
  44     uint32_t sendseq;
  45     uint32_t lastrecvseq;
  46     uint32_t max_skew;
  47     bool_t keyed;
  48 };
  49
  50 #define PKCS5_MASK 15
  51
  52 static bool_t transform_setkey(void *sst, uint8_t *key, uint32_t keylen)
  53 {
  54     struct transform_inst *ti=sst;
  55
  56     if (keylen<REQUIRED_KEYLEN) {
  57         Message(M_ERR,"transform_create: insufficient key material supplied "
  58                 "(need %d bytes, got %d)\n",REQUIRED_KEYLEN,keylen);
  59         return False;
  60     }
  61
  62 #if 0
  63     {
  64         int i;
  65         printf("Setting key to: ");
  66         for (i=0; i<keylen; i++)
  67             printf("%02x",key[i]);
  68         printf("\n");
  69     }
  70 #endif /* 0 */
  71
  72     serpent_makekey(&ti->cryptkey,256,key);
  73     serpent_makekey(&ti->mackey,256,key+32);
  74     ti->cryptiv=ntohl(*(uint32_t *)(key+64));
  75     ti->maciv=ntohl(*(uint32_t *)(key+68));
  76     ti->sendseq=ntohl(*(uint32_t *)(key+72));
  77     ti->lastrecvseq=ti->sendseq;
  78     ti->keyed=True;
  79
  80     return True;
  81 }
  82
  83 static void transform_delkey(void *sst)
  84 {
  85     struct transform_inst *ti=sst;
  86
  87     memset(&ti->cryptkey,0,sizeof(ti->cryptkey));
  88     memset(&ti->mackey,0,sizeof(ti->mackey));
  89     ti->keyed=False;
  90 }
  91
  92 static uint32_t transform_forward(void *sst, struct buffer_if *buf,
  93                                   char **errmsg)
  94 {
  95     struct transform_inst *ti=sst;
  96     uint8_t *padp;
  97     int padlen;
  98     uint32_t iv[4];
  99     uint32_t macplain[4];
 100     uint32_t macacc[4];
 101     uint32_t *n, *p;
 102
 103     if (!ti->keyed) {
 104         *errmsg="transform unkeyed";
 105         return 1;
 106     }
 107
 108     /* Sequence number */
 109     buf_prepend_uint32(buf,ti->sendseq);
 110     ti->sendseq++;
 111
 112     /* PKCS5, stolen from IWJ */
 113                                     /* eg with blocksize=4 mask=3 mask+2=5   */
 114                                     /* msgsize    20    21    22    23   24  */
 115     padlen= PKCS5_MASK-buf->size;   /*           -17   -18   -19   -16  -17  */
 116     padlen &= PKCS5_MASK;           /*             3     2     1     0    3  */
 117     padlen++;                       /*             4     3     2     1    4  */
 118
 119     padp=buf_append(buf,padlen);
 120     memset(padp,padlen,padlen);
 121
 122     /* Serpent-CBCMAC. We expand the IV from 32-bit to 128-bit using
 123        one encryption. Then we do the MAC and append the result. We don't
 124        bother sending the IV - it's the same each time. (If we wanted to send
 125        it we've have to add 16 bytes to each message, not 4, so that the
 126        message stays a multiple of 16 bytes long.) */
 127     memset(iv,0,16);
 128     iv[0]=ti->maciv;
 129     serpent_encrypt(&ti->mackey,iv,macacc);
 130
 131     /* CBCMAC: encrypt in CBC mode. The MAC is the last encrypted
 132        block encrypted once again. */
 133     for (n=(uint32_t *)buf->start; n<(uint32_t *)(buf->start+buf->size); n+=4)
 134     {
 135 #ifdef WORDS_BIGENDIAN
 136         macplain[0]=macacc[0]^byteswap(n[0]);
 137         macplain[1]=macacc[1]^byteswap(n[1]);
 138         macplain[2]=macacc[2]^byteswap(n[2]);
 139         macplain[3]=macacc[3]^byteswap(n[3]);
 140 #else
 141         macplain[0]=macacc[0]^n[0];
 142         macplain[1]=macacc[1]^n[1];
 143         macplain[2]=macacc[2]^n[2];
 144         macplain[3]=macacc[3]^n[3];
 145 #endif
 146         serpent_encrypt(&ti->mackey,macplain,macacc);
 147     }
 148     serpent_encrypt(&ti->mackey,macacc,macacc);
 149 #ifdef WORDS_BIGENDIAN
 150     macacc[0]=byteswap(macacc[0]);
 151     macacc[1]=byteswap(macacc[1]);
 152     macacc[2]=byteswap(macacc[2]);
 153     macacc[3]=byteswap(macacc[3]);
 154 #endif
 155     memcpy(buf_append(buf,16),macacc,16);
 156
 157     /* Serpent-CBC. We expand the ID as for CBCMAC, do the encryption,
 158        and prepend the IV before increasing it. */
 159     memset(iv,0,16);
 160     iv[0]=ti->cryptiv;
 161     serpent_encrypt(&ti->cryptkey,iv,iv);
 162
 163     /* CBC: each block is XORed with the previous encrypted block (or the IV)
 164        before being encrypted. */
 165     p=iv;
 166 #ifdef WORDS_BIGENDIAN
 167     /* This counters the byteswap() in the first half of the loop, which in
 168        turn counters the byteswap() in the second half of the loop. Ick. */
 169     iv[0]=byteswap(iv[0]);
 170     iv[1]=byteswap(iv[1]);
 171     iv[2]=byteswap(iv[2]);
 172     iv[3]=byteswap(iv[3]);
 173 #endif
 174     for (n=(uint32_t *)buf->start; n<(uint32_t *)(buf->start+buf->size); n+=4)
 175     {
 176 #ifdef WORDS_BIGENDIAN
 177         /* Think of this as byteswap(p[x])^byteswap(n[x]) */
 178         n[0]=byteswap(p[0]^n[0]);
 179         n[1]=byteswap(p[1]^n[1]);
 180         n[2]=byteswap(p[2]^n[2]);
 181         n[3]=byteswap(p[3]^n[3]);
 182 #else
 183         n[0]=p[0]^n[0];
 184         n[1]=p[1]^n[1];
 185         n[2]=p[2]^n[2];
 186         n[3]=p[3]^n[3];
 187 #endif
 188         serpent_encrypt(&ti->cryptkey,n,n);
 189 #ifdef WORDS_BIGENDIAN
 190         n[0]=byteswap(n[0]);
 191         n[1]=byteswap(n[1]);
 192         n[2]=byteswap(n[2]);
 193         n[3]=byteswap(n[3]);
 194 #endif
 195         p=n;
 196     }
 197
 198     buf_prepend_uint32(buf,ti->cryptiv);
 199     ti->cryptiv++;
 200     return 0;
 201 }
 202
 203 static uint32_t transform_reverse(void *sst, struct buffer_if *buf,
 204                                   char **errmsg)
 205 {
 206     struct transform_inst *ti=sst;
 207     uint8_t *padp;
 208     unsigned padlen;
 209     int i;
 210     uint32_t seqnum, skew;
 211     uint32_t iv[4];
 212     uint32_t pct[4];
 213     uint32_t macplain[4];
 214     uint32_t macacc[4];
 215     uint32_t *n;
 216     uint32_t *macexpected;
 217
 218     if (!ti->keyed) {
 219         *errmsg="transform unkeyed";
 220         return 1;
 221     }
 222
 223
 224     /* CBC */
 225     memset(iv,0,16);
 226     iv[0]=buf_unprepend_uint32(buf);
 227     /* Assert bufsize is multiple of blocksize */
 228     if (buf->size&0xf) {
 229         *errmsg="msg not multiple of cipher blocksize";
 230     }
 231     serpent_encrypt(&ti->cryptkey,iv,iv);
 232     for (n=(uint32_t *)buf->start; n<(uint32_t *)(buf->start+buf->size); n+=4)
 233     {
 234 #ifdef WORDS_BIGENDIAN
 235         n[0]=byteswap(n[0]);
 236         n[1]=byteswap(n[1]);
 237         n[2]=byteswap(n[2]);
 238         n[3]=byteswap(n[3]);
 239 #endif
 240         pct[0]=n[0]; pct[1]=n[1]; pct[2]=n[2]; pct[3]=n[3];
 241         serpent_decrypt(&ti->cryptkey,n,n);
 242 #ifdef WORDS_BIGENDIAN
 243         n[0]=byteswap(iv[0]^n[0]);
 244         n[1]=byteswap(iv[1]^n[1]);
 245         n[2]=byteswap(iv[2]^n[2]);
 246         n[3]=byteswap(iv[3]^n[3]);
 247 #else
 248         n[0]=iv[0]^n[0];
 249         n[1]=iv[1]^n[1];
 250         n[2]=iv[2]^n[2];
 251         n[3]=iv[3]^n[3];
 252 #endif
 253         iv[0]=pct[0]; iv[1]=pct[1]; iv[2]=pct[2]; iv[3]=pct[3];
 254     }
 255
 256     /* CBCMAC */
 257     macexpected=buf_unappend(buf,16);
 258     memset(iv,0,16);
 259     iv[0]=ti->maciv;
 260     serpent_encrypt(&ti->mackey,iv,macacc);
 261
 262     /* CBCMAC: encrypt in CBC mode. The MAC is the last encrypted
 263        block encrypted once again. */
 264     for (n=(uint32_t *)buf->start; n<(uint32_t *)(buf->start+buf->size); n+=4)
 265     {
 266 #ifdef WORDS_BIGENDIAN
 267         macplain[0]=macacc[0]^byteswap(n[0]);
 268         macplain[1]=macacc[1]^byteswap(n[1]);
 269         macplain[2]=macacc[2]^byteswap(n[2]);
 270         macplain[3]=macacc[3]^byteswap(n[3]);
 271 #else
 272         macplain[0]=macacc[0]^n[0];
 273         macplain[1]=macacc[1]^n[1];
 274         macplain[2]=macacc[2]^n[2];
 275         macplain[3]=macacc[3]^n[3];
 276 #endif
 277         serpent_encrypt(&ti->mackey,macplain,macacc);
 278     }
 279     serpent_encrypt(&ti->mackey,macacc,macacc);
 280 #ifdef WORDS_BIGENDIAN
 281     macacc[0]=byteswap(macacc[0]);
 282     macacc[1]=byteswap(macacc[1]);
 283     macacc[2]=byteswap(macacc[2]);
 284     macacc[3]=byteswap(macacc[3]);
 285 #endif
 286     if (memcmp(macexpected,macacc,16)!=0) {
 287         *errmsg="invalid MAC";
 288         return 1;
 289     }
 290
 291     /* PKCS5, stolen from IWJ */
 292
 293     padp=buf_unappend(buf,1);
 294     padlen=*padp;
 295     if (!padlen || (padlen > PKCS5_MASK+1)) {
 296         *errmsg="pkcs5: invalid length";
 297         return 1;
 298     }
 299
 300     padp=buf_unappend(buf,padlen-1);
 301     for (i=0; i<padlen-1; i++) {
 302         if (*++padp != padlen) {
 303             *errmsg="pkcs5: corrupted padding";
 304             return 1;
 305         }
 306     }
 307
 308     /* Sequence number must be within max_skew of lastrecvseq; lastrecvseq
 309        is only allowed to increase. */
 310     seqnum=buf_unprepend_uint32(buf);
 311     skew=seqnum-ti->lastrecvseq;
 312     if (skew<0x8fffffff) {
 313         /* Ok */
 314         ti->lastrecvseq=seqnum;
 315     } else if ((0-skew)<ti->max_skew) {
 316         /* Ok */
 317     } else {
 318         /* Too much skew */
 319         *errmsg="seqnum: too much skew";
 320         return 1;
 321     }
 322
 323     return 0;
 324 }
 325
 326 static void transform_destroy(void *sst)
 327 {
 328     struct transform_inst *st=sst;
 329
 330     memset(st,0,sizeof(*st)); /* Destroy key material */
 331     free(st);
 332 }
 333
 334 static struct transform_inst_if *transform_create(void *sst)
 335 {
 336     struct transform_inst *ti;
 337     struct transform *st=sst;
 338
 339     ti=safe_malloc(sizeof(*ti),"transform_create");
 340     /* mlock XXX */
 341
 342     ti->ops.st=ti;
 343     ti->ops.setkey=transform_setkey;
 344     ti->ops.delkey=transform_delkey;
 345     ti->ops.forwards=transform_forward;
 346     ti->ops.reverse=transform_reverse;
 347     ti->ops.destroy=transform_destroy;
 348     ti->max_skew=st->max_seq_skew;
 349     ti->keyed=False;
 350
 351     return &ti->ops;
 352 }
 353
 354 static list_t *transform_apply(closure_t *self, struct cloc loc,
 355                                dict_t *context, list_t *args)
 356 {
 357     struct transform *st;
 358     item_t *item;
 359     dict_t *dict;
 360
 361     st=safe_malloc(sizeof(*st),"serpent");
 362     st->cl.description="serpent-cbc256";
 363     st->cl.type=CL_TRANSFORM;
 364     st->cl.apply=NULL;
 365     st->cl.interface=&st->ops;
 366     st->ops.st=st;
 367     st->ops.max_start_pad=28; /* 4byte seqnum, 16byte pad, 4byte MACIV,
 368                                  4byte IV */
 369     st->ops.max_end_pad=16; /* 16byte CBCMAC */
 370
 371     /* We need 256*2 bits for serpent keys, 32 bits for CBC-IV and 32 bits
 372        for CBCMAC-IV, and 32 bits for init sequence number */
 373     st->ops.keylen=REQUIRED_KEYLEN;
 374     st->ops.create=transform_create;
 375
 376     /* First parameter must be a dict */
 377     item=list_elem(args,0);
 378     if (!item || item->type!=t_dict)
 379         cfgfatal(loc,"userv-ipif","parameter must be a dictionary\n");
 380
 381     dict=item->data.dict;
 382     st->max_seq_skew=dict_read_number(dict, "max-sequence-skew",
 383                                       False, "serpent-cbc256", loc, 10);
 384
 385     return new_closure(&st->cl);
 386 }
 387
 388 init_module transform_module;
 389 void transform_module(dict_t *dict)
 390 {
 391     struct keyInstance k;
 392     uint8_t data[32];
 393     uint32_t plaintext[4];
 394     uint32_t ciphertext[4];
 395
 396     /* Serpent self-test */
 397     memset(data,0,32);
 398     serpent_makekey(&k,256,data);
 399     plaintext[0]=0x00000000;
 400     plaintext[1]=0x00000001;
 401     plaintext[2]=0x00000002;
 402     plaintext[3]=0x00000003;
 403     serpent_encrypt(&k,plaintext,ciphertext);
 404     if (ciphertext[3]!=0x7ca73bb0 ||
 405         ciphertext[2]!=0x83C31E69 ||
 406         ciphertext[1]!=0xec52bd82 ||
 407         ciphertext[0]!=0x27a46120) {
 408         fatal("transform_module: serpent failed self-test (encrypt)");
 409     }
 410     serpent_decrypt(&k,ciphertext,plaintext);
 411     if (plaintext[0]!=0 ||
 412         plaintext[1]!=1 ||
 413         plaintext[2]!=2 ||
 414         plaintext[3]!=3) {
 415         fatal("transform_module: serpent failed self-test (decrypt)");
 416     }
 417
 418     add_closure(dict,"serpent256-cbc",transform_apply);
 419 }