luaBn-c-api.3

.\" Copyright (c) 2013 Alexander Nasonov.
.\" All rights reserved.
.\" 
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. 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 HOLDERS 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.
.\"
.Dd May 7, 2013
.Dt luaBn-c-api 3
.Sh NAME
.Nm luaBn-c-api
.Nd C interface of the luaBn library
.Sh LIBRARY
luaBn Library (luaBn, \-lluaBn \-lcrypto)
.Sh SYNOPSIS
.In luaBn.h
.Ft int
.Fn luaBn_open "lua_State *L"
.Ft BIGNUM *
.Fn luaBn_tobignum "lua_State *L" "int narg"
.Sh DESCRIPTION
The
.Nm
specifies C interface of the luaBn library.
.Pp
In order yo use the library, you should initialise it with
.Fn luaBn_open .
It's recommended to call
.Xr ERR_load_BN_strings 3
prior to calling
.Fn luaBn_open
for a better error reporting.
The library uses Lua state for storing global variables (such as
.Xr BN_CTX 3
objects) and it's possible to have multiple instances of the library
open in multiple Lua states and running in multiple threads.
.Pp
Lua string, number or bn.bignum object can be converted to
.Xr BIGNUM 3
object using
.Fn luaBn_tobignum
function.
.Pp
.Sh AUTHORS
.An Alexander Nasonov Aq alnsn@yandex.ru