---
name: "shishi_string_to_key"
section: "3"
platform: "linux"
package: "shishi-doc"
version: "1.0.3-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/shishi_string_to_key"
---

# shishi\_string\_to\_key(3)

API function

## NAME

shishi\_string\_to\_key - API function

## SYNOPSIS

**#include \<shishi.h\>**

**int shishi\_string\_to\_key(Shishi \*** *handle***, int32\_t** *keytype***, const char \*** *password***, size\_t** *passwordlen***, const char \*** *salt***, size\_t** *saltlen***, const char \*** *parameter***, Shishi\_key \*** *outkey***);**

## ARGUMENTS

- Shishi \* handle

  shishi handle as allocated by **shishi\_init()**.

- int32\_t keytype

  cryptographic encryption type, see Shishi\_etype.

- const char \* password

  input array with password.

- size\_t passwordlen

  length of input array with password.

- const char \* salt

  input array with salt.

- size\_t saltlen

  length of input array with salt.

- const char \* parameter

  input array with opaque encryption type specific information.

- Shishi\_key \* outkey

  allocated key handle that will contain new key.

## DESCRIPTION

Derive key from a string (password) and salt (commonly concatenation of realm and principal) for specified key type, and set the type and value in the given key to the computed values. The parameter value is specific for each keytype, and can be set if the parameter information is not available.

## RETURN VALUE

Returns **SHISHI\_OK** iff successful.

## REPORTING BUGS

Report bugs to \<bug-shishi@gnu.org\>. GNU Shishi home page: http://www.gnu.org/software/shishi/ General help using GNU software: http://www.gnu.org/gethelp/

## COPYRIGHT

Copyright © 2002-2022 Simon Josefsson.\
 Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.

## SEE ALSO

The full documentation for **shishi** is maintained as a Texinfo manual.  If the **info** and **shishi** programs are properly installed at your site, the command

-

  **info shishi**

should give you access to the complete manual.