From patchwork Tue Dec 15 12:01:19 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alexandru Badicioiu X-Patchwork-Id: 58429 Delivered-To: patch@linaro.org Received: by 10.112.129.4 with SMTP id ns4csp149278lbb; Tue, 15 Dec 2015 04:02:54 -0800 (PST) X-Received: by 10.55.72.70 with SMTP id v67mr36082108qka.47.1450180974198; Tue, 15 Dec 2015 04:02:54 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id m205si851499qhm.111.2015.12.15.04.02.52; Tue, 15 Dec 2015 04:02:54 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 78248619C5; Tue, 15 Dec 2015 12:02:52 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H2, SPF_HELO_PASS, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id 32E06618D9; Tue, 15 Dec 2015 12:02:47 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 3C9D461941; Tue, 15 Dec 2015 12:02:43 +0000 (UTC) Received: from na01-bn1-obe.outbound.protection.outlook.com (mail-bn1bon0097.outbound.protection.outlook.com [157.56.111.97]) by lists.linaro.org (Postfix) with ESMTPS id 8FD5661981 for ; Tue, 15 Dec 2015 12:01:26 +0000 (UTC) Received: from DM2PR03CA0032.namprd03.prod.outlook.com (10.141.96.31) by BLUPR0301MB2116.namprd03.prod.outlook.com (10.164.22.158) with Microsoft SMTP Server (TLS) id 15.1.355.16; Tue, 15 Dec 2015 12:01:24 +0000 Received: from BN1BFFO11FD016.protection.gbl (2a01:111:f400:7c10::1:125) by DM2PR03CA0032.outlook.office365.com (2a01:111:e400:2428::31) with Microsoft SMTP Server (TLS) id 15.1.355.16 via Frontend Transport; Tue, 15 Dec 2015 12:01:25 +0000 Authentication-Results: spf=softfail (sender IP is 192.88.158.2) smtp.mailfrom=linaro.org; linaro.org; dkim=none (message not signed) header.d=none; linaro.org; dmarc=none action=none header.from=linaro.org; Received-SPF: SoftFail (protection.outlook.com: domain of transitioning linaro.org discourages use of 192.88.158.2 as permitted sender) Received: from az84smr01.freescale.net (192.88.158.2) by BN1BFFO11FD016.mail.protection.outlook.com (10.58.144.79) with Microsoft SMTP Server (TLS) id 15.1.346.13 via Frontend Transport; Tue, 15 Dec 2015 12:01:24 +0000 Received: from fsr-fed2064-008.ea.freescale.net (fsr-fed2064-008.ea.freescale.net [10.171.95.70]) by az84smr01.freescale.net (8.14.3/8.14.0) with ESMTP id tBFC1MpO011240; Tue, 15 Dec 2015 05:01:22 -0700 From: To: Date: Tue, 15 Dec 2015 14:01:19 +0200 Message-ID: <1450180879-3227-1-git-send-email-alexandru.badicioiu@linaro.org> X-Mailer: git-send-email 1.9.3 X-EOPAttributedMessage: 0 X-Matching-Connectors: 130946544846822203; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Microsoft-Exchange-Diagnostics: 1; BN1BFFO11FD016; 1:cW9J0dIDX0NhReVk5SwYAPcOSE5GTvlP6JzESiI5TCmffxD0q5iD+gavH+GUm7+vQFU9DlyfiwxXRmQcqWshhLeUfcL3KY6xqwrmhmOd9kFWp5s+tH94P8IlfkORwDvXcPaFSfnqI1JcwTYNDB85+LQcCp7Q+77HjF4Qk5N10Kb5lgvL2St43yojqPYQWPHN+wzw8D2BTomL/0+kfoIsrBPM5L2OSOr0F6Ib3fX2QTd+BUQjKzowWCJwJ9haQFtPxzJ1PC1E3d4s5ZI1qvGdm6HbeyVuf92Zl0yVs3GmxIu6btwX2ZmK6ZQ+D8+ruBQvhdhMDjm0IEXyEE9SlJPYKxoi+sadp7INKoHelgtOthkyJ2cXa5g4PiWkNT5vrzw40ksXtMN+pQCWGyQMfAc3uKgKXcMVsuGgPhRd/g/WAE4vD0yoTjiostHcAq0fqy3Y X-Forefront-Antispam-Report: CIP:192.88.158.2; CTRY:US; IPV:NLI; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(2980300002)(189002)(199003)(19580395003)(97736004)(6806005)(48376002)(87936001)(19580405001)(110136002)(5003940100001)(47776003)(81156007)(77096005)(5001960100002)(50466002)(69596002)(86152002)(104016004)(50986999)(33646002)(1096002)(1220700001)(50226001)(5008740100001)(106466001)(105596002)(92566002)(36756003)(86362001)(586003)(2351001)(229853001)(189998001); DIR:OUT; SFP:1101; SCL:1; SRVR:BLUPR0301MB2116; H:az84smr01.freescale.net; FPR:; SPF:SoftFail; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; MIME-Version: 1.0 X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB2116; 2:Zb/YaVlbRnm6ZOCDPRHnTF/wmW25TN41nBd03oXBqFhYbVo9oAmkNf2cEc8uBJ8m345c/s/bX9Roxq95MKaINU1wRJJRhFSRJrDwUUrAa4sdAWTLcbRI5kv0rfckqwgCTzkCOUa0kCPx8VZqcOvYUA==; 3:QqbkzID/0bT20m/Z8WzlLbJ17psIm97Ov+Bqmj+wzMRo+dQ0GFTuNFGYUaThDHync/XsWGCfk7074ZxpFGf6JWAyUz9jxNQC5Vdu4z2lTloDnB7EA+QH2Jp9RV3AiZ0vZN85mk6gdAadIJeXY/1up3CZKvBx0by/zexxsoKRTJexCywRGLyJO5rMPhet3RcAPajoVmaSiJqaV95xVJJ6hpnTg9WjHmWjLOz1g0vGi88=; 25:eoyr34+Eiw55rqZNHlbPKY0B8/bvS4lcZWZ8Jmxw5Euuk+m3Y21i7D1XsuHfUjFwr7sNUFVAYdGIpfOTJXUabtAI8ynq8IEU2UH9QYK8Zln+5wU5bzxGNlVf+05eAxYtE6qhZA3SQZ4ZVQ3h6S4wBGfinGqKd4UT2iZy1dUeazSMWQiVNfC841sbqS0ren5TSyC/ml3VvpEbm9P7NffciAGj+4HEg7AvK+QjxvABd3pVp3ujfqlIqqmQvYVpuE0CDe2YgFrpMHgWstxhVtkRuQ== X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:BLUPR0301MB2116; X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(601004)(2401047)(5005006)(8121501046)(520078)(10201501046)(3002001); SRVR:BLUPR0301MB2116; BCL:0; PCL:0; RULEID:(400006); SRVR:BLUPR0301MB2116; X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB2116; 4:4S/hssuHTjmAcQKzOGUVci+eS6xZXnXfEaAZs3fEG5rS1cEhHBBqJXMSiYv+gb2xXTiGqGnlbotiw1Hj90YuJ4KVJZ0xyhpwqm4iUbc+1sf+aufgdwB0QBYe1W+gd8Lga4WCuPJpj3y/nMrOqeMAKqaHRs63s7MzUob3PA9iksRQ9V83Z2/PjQfxYy84kBzs5t9cEL7Sl8YDHG8U3wQDuXQTLFIUxnsnuvDDmAx02NEKkVbv8l+/UiJXW4Rcc2NJdWNu5v885dx01hZx9fIUY+cYWk4WUrcPnU+C9pvAEtxpZjBhuKrL1mmi9p58kv4GZusjdIAwkb8RvVCrhO/uCAkTGphQWYzf2MO2Pea+rCF9pqmEUFMHdKs6/uWcRH92 X-Forefront-PRVS: 07915F544A X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB2116; 23:xMEvXkTGWl3HrjKRTuZyKfsQ88WJrsqxqNSXreMTIqTQRAuqo2KOtdoviGP5FG6d8uD8gYKih0OQ/Ofkh4hLfxRAe8RFTc70oDPcmtPebhOXWfz2WcgSrXSOTiYJ+RoFuhN4z+TENuBRAdnvDMniSVdYWydlYyjGCYYNK3rigVsvK2bjab7HIK6rSz1ccJvVQgpbe3+OOCI+RkyK2idIhsJzsfwCVhwTqPesF9xTSWUtfuoVuEpzxcbZrGNUoV9ISGX0n+hqkpLC8+9XVfC5cePSSOzEFDGF05BOt+IjJRBiYkgo/M/B9I5zW9zObsrb62tL0jiramqk9/Y/dPEkvLTzV/WxBFI+dsXyzmDAv6rvgsgIk/ZrhrXgaHgb8kCW9eEbs4jkpmiaITAT5ir3rHH4BxDcgEsStTjL5FssfzIiYvhbcnQbAtCJVVED2iBrcVqq/RGt4JLls/RG1cNJIbeRxi47ccQtzcxrgMchN8dYTC2bSy9DFfekx9SZgM/fD9rjxeDzOCxW9WKoR6UYBrcotiXe0vXlwvfhS+E3NyF0MtG+ML1GMdDy9ENs+O3JBEFRolL4K3JAMfsDbxpidl3zZxGngJzIvnyDdlRBEAjdG6J0LN+5D1mhhPiPwQoql8cBFrgp/pmJrPywW+tg2V54kgyTtVnSOZVmTubp9tP1CYdBEaIBfv+c+d+pIZ6YHwYq3xvvf+0zgzZpYzuhRl4VLdJRwRo0ZRKNv1kldPOusFf7fSW9CZ7PNceOF7DmvTKnEEyh2A4oE3bSUPdaqqCWNZogdyEpPWi4PhEhwaC5hJCjcl1WsgU617O6HtWPMPz24VXN8LwuaefWNnd0OQ0O+hRZrxwpO3LIDJcU9eIhsZFzXt98DIO6XTLR5z0pB2ZeDIe+mHIrTq5LC+KQjskgxD67DfnAwSE2i0wrGikhVpI/FsVPQXiExrgMByhr X-Microsoft-Exchange-Diagnostics: 1; BLUPR0301MB2116; 5:Ho5kBGSEMKlmdGjORoqtOZVsPDyMMpoC7tN+9Rsxu0oTQ9zC/8pTXbnRp0uN06js9qQwUD8yBrmtFHD8TTyrJOmerJ0rDri3KrIAN8Cb5+nDs1faLQd05/tXUKMgY0r2nqNAKyI8zO/WwBDZbaZAHH3plF6VY3qynkTQp/uys8A=; 24:SlGV1B73m6TZ+3sCgJr1g9HsoyAqXNZTwjQ4YayUxMWZ2U6vzrliIqEDRRGB2eDRuA3st3DNZPoHL7DJP3I6L9xcUO5EAfXmgopIqBN2vhc= SpamDiagnosticOutput: 1:23 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 15 Dec 2015 12:01:24.1050 (UTC) X-MS-Exchange-CrossTenant-Id: 5afe0b00-7697-4969-b663-5eab37d5f47e X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5afe0b00-7697-4969-b663-5eab37d5f47e; Ip=[192.88.158.2]; Helo=[az84smr01.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: BLUPR0301MB2116 X-Topics: crypto patch Subject: [lng-odp] [PATCH v1] doc/users-guide: add cryptographic services section X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" From: Alexandru Badicioiu Signed-off-by: Alexandru Badicioiu Reviewed-by: Bill Fischofer --- doc/users-guide/users-guide.adoc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/users-guide/users-guide.adoc b/doc/users-guide/users-guide.adoc index 2e30f3a..7ec7957 100644 --- a/doc/users-guide/users-guide.adoc +++ b/doc/users-guide/users-guide.adoc @@ -738,6 +738,27 @@ NOTE: Both ordered and parallel queues improve throughput over atomic queues due to parallel event processing, but require that the application take steps to ensure context data synchronization if needed. +=== Cryptographic services + +ODP provides support for cryptographic operations required by various security +protocols (e.g. IPSec). To apply a cryptographic operation to a packet a session +must be created first. Packets processed by a session share the same cryptographic +parameters like algorithms, keys, initialization vectors. A session is created with +odp_crypto_session_create() call. After session creation a cryptographic operation +can be applied to a packet using odp_crypto_operation() call. +Depending on the session type - synchronous or asynchronous the operation returns +when the operation completed or after the request has been submitted. In the +asynchronous case an operation completion event will be enqueued on the session +completion queue. The completion event conveys the status of the operation and +the result. The application has the responsibility to free the completion event. +The operation arguments specify for each packet the areas which are to be encrypted +or decrypted and authenticated. Also, in asynchronous case a context can be +associated with a given operation and when the operation completion event is +retrieved the associated context can be retrieved. An operation can be executed +in-place, when the output packet is the same as the input packet or the output +packet can be a new packet provided by the application or allocated by the +implementation from the session output pool. + == Glossary [glossary] worker thread::