#include "include/jsecresponder.h"

Detailed Description

Responder for NXP SEC(CAAM) unit for testbench in Protocol++® (ProtocolPP®)

The responder class for Protocol++® (ProtocolPP®) is meant to mimic hardware that is being tests or prototyped for a protocol. The logger objects is used to output information

The responder uses three rings, one for the security associations or flows that are being processed by the responder, one for the input data, and one for the output data. Note they they use the ring class of Protocol++® (ProtocolPP®)

The programmable delay times are avaiable to allow the user to define a range of latencies for reading memory, computing the packet, and writing to memory. Ranges are provided so the min and max values can be used and are in microseconds

For reproducibility, a seed is passed from the calling function so a jrand object can be created to randomize read, compute, and randomization times as well as to be used in the responder for creating random data for protocol processing

The constructor for jresponder is found below

jresponder(std::shared_ptr<jlogger>& logger,
           std::shared_ptr<jring<ringflow>>& flowring,
           std::shared_ptr<jring<ringin>>& inputring,
           std::shared_ptr<jring<ringout>>& outputring,
           unsigned long seed,
           std::string readlatency=std::string("80..120"),
           std::string computelatency=std::string("2000..5000"),
           std::string writelatency=std::string("50..100"));

There are several accessor functions for the responder as follows

// enqueue flows to responder
void dequeue(std::string flow);
 
// dequeue flows from responder
void enqueue(std::string& flow);
 
// push another packet to the output ring, creates ringout then
// push to the output ring
void push(uint64_t packet,
          uint32_t size,
          uint32_t status);
 
// pop next packet from the input ring
ringin pop();
 
// run the responder, should be called from a separate thread
void run();

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:

jresponder/include/jsecresponder.h