scrypt-1.2.1/lib/crypto/crypto_scrypt.h

   1 /*-
   2  * Copyright 2009 Colin Percival
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * This file was originally written by Colin Percival as part of the Tarsnap
  27  * online backup system.
  28  */
  29 #ifndef _CRYPTO_SCRYPT_H_
  30 #define _CRYPTO_SCRYPT_H_
  31
  32 #include <stdint.h>
  33 #include <unistd.h>
  34
  35 /**
  36  * crypto_scrypt(passwd, passwdlen, salt, saltlen, N, r, p, buf, buflen):
  37  * Compute scrypt(passwd[0 .. passwdlen - 1], salt[0 .. saltlen - 1], N, r,
  38  * p, buflen) and write the result into buf.  The parameters r, p, and buflen
  39  * must satisfy r * p < 2^30 and buflen <= (2^32 - 1) * 32.  The parameter N
  40  * must be a power of 2 greater than 1.
  41  *
  42  * Return 0 on success; or -1 on error.
  43  */
  44 int crypto_scrypt(const uint8_t *, size_t, const uint8_t *, size_t, uint64_t,
  45     uint32_t, uint32_t, uint8_t *, size_t);
  46
  47 #endif /* !_CRYPTO_SCRYPT_H_ */