.\"=============================================================================
.\" Header
.\"
.\" Copyright (c) 2018-2024 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.
.\"
.\" SPDX-License-Identifier: ICU
.\"
.\"
.TH $NAME 3 $DATE Unix "$NAME $VERSION manual"
.\"
.\"
.\"=============================================================================
.\" NAME section
.\"
.SH NAME
cl_get_lock - Create Cancel-Lock with $NAME
.\"
.\"
.\"=============================================================================
.\" SYNOPSIS section
.\"
.SH SYNOPSIS
.nf
.B #include <libcanlock-3/canlock.h>
.sp
.BI "char *cl_get_lock(cl_hash_version " hash ,
.BI "                  const unsigned char *" sec ", size_t " sec_len ,
.BI "                  const unsigned char *" msg ", size_t " msg_len );
.fi
.sp
Supported values for
.I hash
(by version 3.0.0 of $NAME):
.br
CL_SHA1 CL_SHA224 CL_SHA256 CL_SHA384 CL_SHA512
.\"
.\"
.\"=============================================================================
.\" DESCRIPTION section
.\"
.SH DESCRIPTION
The
.BR cl_get_lock ()
function creates a <c-lock> element according to the algorithm recommended by
RFC 8315 in Section 4. The hash algorithm selected for <scheme> is used for the
HMAC operation too.
.sp
The hash algorithm for <scheme> is selected with
.IR "hash" .
.sp
The local secret is specified with
.IR sec " (" sec_len
must be set to the length of
.IR "sec" ).
.br
The length of the local secret should be at least the length of the hash
that was selected for <scheme> (32 octets for SHA256).
.sp
The Message-ID of the target article (the one for which the lock is intended)
is specified with
.IR msg " (" msg_len
must be set to the length of
.IR "msg" ).
.sp
The Message-ID
.IR "msg"
can be prepended with an optional User-ID. The length of the User-ID must be
added to
.IR "msg_len" .
The User-ID must not contain angle brackets.
.\"
.\"
.\"=============================================================================
.\" RETURN VALUE section
.\"
.SH RETURN VALUE
Upon successful completion a pointer to the result string is returned.
Otherwise,
.B NULL
is returned.
.sp
On success the caller is responsible to call
.BR free ()
for the pointer returned as result.
.\"
.\"
.\"=============================================================================
.\" AUTHORS section
.\"
.SH AUTHORS
Dennis Preiser
.br
(Based in part on the implementation from G. J. Andruk for Version 2)
.sp
The base64 implementation is written by Kungliga Tekniska Hogskolan
(Royal Institute of Technology, Stockholm, Sweden)
.sp
The hash algorithms are implemented with code from RFC 6234
.\"
.\"
.\"=============================================================================
.\" REPORTING BUGS section
.\"
.SH REPORTING BUGS
Report bugs to <mailto:$BUGREPORT>.
.\"
.\"
.\"=============================================================================
.\" STANDARDS section
.\"
.SH STANDARDS
.B $NAME
tries to comply with the following standards:
.PP
RFC 5537, RFC 6234, RFC 8315
.\"
.\"
.\"=============================================================================
.\" SEE ALSO section
.\"
.SH SEE ALSO
.BR free (3),
.BR cl_clear_secret (3),
.BR cl_get_key (3),
.BR cl_split (3),
.BR cl_verify (3),
.BR cl_verify_multi (3),
.BR canlock (1)
.\"
.\"
.\" EOF
