#include "include/jikencrypt.h"

Detailed Description

IKE Encrypt and Integrity Functions

Class to provide all the encryption and authentication algorithms and functionality needed for Internet Key Exchange (IKEv2). Also provides an interface to the Linux kernel to retrieve data from the hardware random number generator. See kcapi for additional details about the kernel interface

The class has a single constuctor that requires a logger object and randomizer as shown below

jikencrypt(std::shared_ptr<InterfacePP::jlogger>& logger,

std::shared_ptr<jrand>& rand);

jikencrypt

Accessor function to provide direct access to the Kernel's hardware random number generator. Requires a byte pointer and the length required. If not available due to lack of support in the kernel, returns data from the jrand object call to crypto() to retrieve data from RANDP. Returns 0 on success, non-zero otherwise

int get_random(uint8_t *buf,

uint32_t len);

Encryption method for IKEv2. Accepts the Security Association created during the initial 4-way handshake. Input can be any amount of data, with plaintext or ciphertext returned in the output pointer. If the cipher uses an IV, it can be passed as the last function

bool encrypt(direction_t dir,
             std::shared_ptr<jikev2sa>& sa,
             jarray<uint8_t>& input,
             std::shared_ptr<jarray<uint8_t>>& output,
             std::shared_ptr<jarray<uint8_t>>& iv);

Authentication method for IKEv2. Used when the cipher chosen by the responder requires a separate authenticator (AES-CBC, AES-CTR). Not needed for AEAD ciphers such as AES-GCM, AES-CCM, CHACHA20-POLY1305

bool integrity(direction_t dir,
               std::shared_ptr<jikev2sa>& sa,
               jarray<uint8_t>& input,
               std::shared_ptr<jarray<uint8_t>>& icv);

For API information:

See also: ProtocolPP::jikev2; ProtocolPP::jrand; ProtocolPP::jenum; ProtocolPP::jsecass; ProtocolPP::jikev2sa; ProtocolPP::jipsecsa; ProtocolPP::jikencrypt; InterfacePP::ringflow

For Additional Documentation:

See also: jikev2; jrand; jenum; jsecass; jikev2sa; jipsecsa; jikencrypt; ringflow

The source code contained or described herein and all documents related to the source code (herein called "Material") are owned by John Peter Greninger and Sheila Rocha Greninger. Title to the Material remains with John Peter Greninger and Sheila Rocha Greninger. The Material contains trade secrets and proprietary and confidential information of John Peter Greninger and Sheila Rocha Greninger. The Material is protected by worldwide copyright and trade secret laws and treaty provisions. No part of the Material may be used, copied, reproduced, modified, published, uploaded, posted, transmitted, distributed, or disclosed in any way without prior express written consent of John Peter Greninger and Sheila Rocha Greninger (both are required)

No license under any patent, copyright, trade secret, or other intellectual property right is granted to or conferred upon you by disclosure or delivery of the Materials, either expressly, by implication, inducement, estoppel, or otherwise. Any license under such intellectual property rights must be express and approved by John Peter Greninger and Sheila Rocha Greninger in writing

Licensing information can be found at www.protocolpp.com/license with use of the binary forms permitted provided that the following conditions are met:

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
Any and all modifications must be returned to John Peter Greninger at GitHub.com https://github.com/jpgreninger/protocolpp for evaluation. Inclusion of modifications in the source code shall be determined solely by John Peter Greninger. Failure to provide modifications shall render this license NULL and VOID and revoke any rights to use of Protocol++®
Commercial use (incidental or not) requires a fee-based license obtainable at www.protocolpp.com/shop
Academic or research use requires prior written and notarized permission from John Peter and Sheila Rocha Greninger

Use of the source code requires purchase of the source code. Source code can be purchased at www.protocolpp.com/shop

US Copyrights at https://www.copyright.gov/
- TXu002059872 (Version 1.0.0)
- TXu002066632 (Version 1.2.7)
- TXu002082674 (Version 1.4.0)
- TXu002097880 (Version 2.0.0)
- TXu002169236 (Version 3.0.1)
- TXu002182417 (Version 4.0.0)
- TXu002219402 (Version 5.0.0)
- TXu002272076 (Version 5.2.1)
- TXu002383571 (Version 5.4.3)

The name of its contributor may not be used to endorse or promote products derived from this software without specific prior written permission and licensing

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTOR "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 OWNER 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

The documentation for this class was generated from the following file:

jikev2/include/jikencrypt.h