/* -*- mode: c; c-basic-offset: 4; indent-tabs-mode: nil -*- */

/* include/k5-hex.h - libkrb5support hex encoding/decoding declarations */

/*

 * Copyright (C) 2018 by the Massachusetts Institute of Technology.

 * All rights reserved.

 *

 * Redistribution and use in source and binary forms, with or without

 * modification, are permitted provided that the following conditions

 * are met:

 *

 * * Redistributions of source code must retain the above copyright

 *   notice, this list of conditions and the following disclaimer.

 *

 * * Redistributions in binary form must reproduce the above copyright

 *   notice, this list of conditions and the following disclaimer in

 *   the documentation and/or other materials provided with the

 *   distribution.

 *

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS

 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE

 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,

 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR

 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

 * OF THE POSSIBILITY OF SUCH DAMAGE.

 */

#ifndef K5_HEX_H

#define K5_HEX_H

#include "k5-platform.h"

/*

 * Encode len bytes in hex, placing the result in allocated storage in

 * *hex_out.  Use uppercase hex digits if uppercase is non-zero.  Return 0 on

 * success, ENOMEM on error.

 */

int k5_hex_encode(const void *bytes, size_t len, int uppercase,

                  char **hex_out);

/*

 * Decode hex bytes, placing the result in allocated storage in *bytes_out and

 * *len_out.  Null-terminate the result (primarily for decoding passwords in

 * libkdb_ldap).  Return 0 on success, ENOMEM or EINVAL on error.

 */

int k5_hex_decode(const char *hex, uint8_t **bytes_out, size_t *len_out);

#endif /* K5_HEX_H */