.\"=============================================================================
.\" Header
.\"
.\" Copyright (c) 2018 Michael Baeuerle
.\"
.\" All rights reserved.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, and/or sell copies of the Software, and to permit persons
.\" to whom the Software is furnished to do so, provided that the above
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
.\"  HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY
.\" SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER
.\" RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
.\" CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
.\" CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
.\"
.TH libcanlock 3 2018-03-16 Unix "libcanlock 3.0.1 manual"
.\"
.\"
.\"=============================================================================
.\" NAME section
.\"
.SH NAME
libcanlock \- Split Cancel-Key or Cancel-Lock
.\"
.\"
.\"=============================================================================
.\" SYNOPSIS section
.\"
.SH SYNOPSIS
.nf
.B #include <libcanlock-3/canlock.h>
.sp
.BI "cl_hash_version cl_split(char *" input ", char **" klstring );
.fi
.sp
Possible return values (by version 3.0.0 of libcanlock):
.br
CL_INVALID CL_SHA1 CL_SHA224 CL_SHA256 CL_SHA384 CL_SHA512
.\"
.\"
.\"=============================================================================
.\" DESCRIPTION section
.\"
.SH DESCRIPTION
The
.BR cl_split ()
function splits a <c-key> or <c-lock> element according to RFC8315.
.sp
The hash algorithm for <scheme> is extracted and the corresponding ID is
returned. If the hash algorithm is not found or not supported, CL_INVALID
is returned.
.sp
A pointer to the <c-key-string> or <c-lock-string> element respectively is
written to
.I klstring
on success (points inside the string
.I input
and therefore no additional memory is allocated).
.br
NULL is written to
.I klstring
on error.
.\"
.\"
.\"=============================================================================
.\" RETURN VALUE section
.\"
.SH RETURN VALUE
Hash algorithm ID (CL_INVALID on error).
.\"
.\"
.\"=============================================================================
.\" AUTHORS section
.\"
.SH AUTHORS
Michael Baeuerle
.br
(Based in part on
.BR lock_strip_alpha()
written by G. J. Andruk for Version 2)
.\"
.\"
.\"=============================================================================
.\" REPORTING BUGS section
.\"
.SH REPORTING BUGS
Report bugs to <mailto:michael.baeuerle@gmx.net>.
.\"
.\"
.\"=============================================================================
.\" STANDARDS section
.\"
.SH STANDARDS
.B libcanlock
tries to comply with the following standards:
.PP
RFC5537, RFC6234, RFC8315
.\"
.\"
.\"=============================================================================
.\" SEE ALSO section
.\"
.SH SEE ALSO
.BR cl_clear_secret (3),
.BR cl_get_key (3),
.BR cl_get_lock (3),
.BR cl_verify (3),
.BR canlock (1)
.\"
.\"
.\" EOF