[gnome-keyring/dbus-api] Add more documentation of algorithms.



commit 4d76282c1007fc10e210cce3fc34b0c0acea8a93
Author: Stefan Walter <Stefan Walter>
Date:   Thu Jul 16 00:59:30 2009 +0000

    Add more documentation of algorithms.

 docs/reference/secrets/secrets-docs.sgml |   18 +++++++++---------
 1 files changed, 9 insertions(+), 9 deletions(-)
---
diff --git a/docs/reference/secrets/secrets-docs.sgml b/docs/reference/secrets/secrets-docs.sgml
index 12bbd38..e18452d 100644
--- a/docs/reference/secrets/secrets-docs.sgml
+++ b/docs/reference/secrets/secrets-docs.sgml
@@ -224,7 +224,7 @@
 				<para>If a service does not support a specific set of algorithms, a 
 				<link linkend='eggdbus-constant-Error.org.freedesktop.Secrets.Error.NotSupported'>NotSupported</link>
 				error is returned, and the client is free to try another set of algorithms. 
-				The <emphasis>PLAIN</emphasis> algorithm is almost always supported.</para>
+				The <emphasis>plain</emphasis> algorithm is almost always supported.</para>
 				
 				<para>An algorithm may require that the Negotiate() method is called multiple
 				times in succession to be complete. Each iteration transfers algorithm specific
@@ -237,10 +237,10 @@
 			</sect1>
 			
 			<sect1>
-				<title>Algorithm: PLAIN</title>
+				<title>Algorithm: plain</title>
 			
 				<simplelist type='vert'>
-				<member>Algorithm string: <emphasis>PLAIN</emphasis></member>
+				<member>Algorithm string: <emphasis>plain</emphasis></member>
 				<member><link linkend='eggdbus-method-org.freedesktop.Secrets.Session.Negotiate'>
 					Negotiate input</link>:  empty string</member>
 				<member><link linkend='eggdbus-method-org.freedesktop.Secrets.Session.Negotiate'>
@@ -252,20 +252,20 @@
 				<para>The plain algorithm does no encryption whatsoever.</para>
 				
 				<para>It is strongly recommended that a service implementing this API support 
-				the <emphasis>PLAIN</emphasis> algorithm.</para>
+				the <emphasis>plain</emphasis> algorithm.</para>
 			</sect1>
 			
 			<sect1>
-				<title>Algorithm: DH-GROUP-???+AES-128</title>
+				<title>Algorithm: dh-ietf1024-aes128-cbc-pkcs7</title>
 				
 				<simplelist type='vert'>
-				<member>Algorithm string: <emphasis>DH-GROUP-???+AES-128</emphasis></member>
+				<member>Algorithm string: <emphasis>dh-ietf1024-aes128-cbc-pkcs7</emphasis></member>
 				<member><link linkend='eggdbus-method-org.freedesktop.Secrets.Session.Negotiate'>
-					Negotiate input</link>: ???TODO??? </member>
+					Negotiate input</link>: client dh pub key as an array of bytes</member>
 				<member><link linkend='eggdbus-method-org.freedesktop.Secrets.Session.Negotiate'>
-					Negotiate output</link>: ???TODO???</member>
+					Negotiate output</link>: service dh pub key as an array of bytes</member>
 				<member><link linkend='eggdbus-struct-Secret'>
-					Secret parameter</link>: 16 byte AES Initialization Vector.</member>
+					Secret parameter</link>: 16 byte AES initialization vector.</member>
 				</simplelist>
 				
 				<para>TODO: Document</para>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]