Document SSL_set_psk_use_session_callback() and SSL_CTX equivalent
[openssl.git] / doc / man3 / SSL_SESSION_get0_id_context.pod
index 2ac3fc4dd024795196cd7a6836388d511c4d7742..69619a72b4346c88e9dc80fffe9e379982f22b39 100644 (file)
@@ -2,7 +2,9 @@
 
 =head1 NAME
 
-SSL_SESSION_get0_id_context - get the SSL ID context associated with a session
+SSL_SESSION_get0_id_context,
+SSL_SESSION_set1_id_context
+- get and set the SSL ID context associated with a session
 
 =head1 SYNOPSIS
 
@@ -10,9 +12,14 @@ SSL_SESSION_get0_id_context - get the SSL ID context associated with a session
 
  const unsigned char *SSL_SESSION_get0_id_context(const SSL_SESSION *s,
                                                   unsigned int *len)
+ int SSL_SESSION_set1_id_context(SSL_SESSION *s, const unsigned char *sid_ctx,
+                                unsigned int sid_ctx_len);
 
 =head1 DESCRIPTION
 
+See L<SSL_CTX_set_session_id_context(3)> for further details on session ID
+contexts.
+
 SSL_SESSION_get0_id_context() returns the ID context associated with
 the SSL/TLS session B<s>. The length of the ID context is written to
 B<*len> if B<len> is not NULL.
@@ -20,9 +27,17 @@ B<*len> if B<len> is not NULL.
 The value returned is a pointer to an object maintained within B<s> and
 should not be released.
 
+SSL_SESSION_set1_id_context() takes a copy of the provided ID context given in
+B<sid_ctx> and associates it with the session B<s>. The length of the ID context
+is given by B<sid_ctx_len> which must not exceed SSL_MAX_SID_CTX_LENGTH bytes.
+
+=head1 RETURN VALUES
+
+SSL_SESSION_set1_id_context() returns 1 on success or 0 on error.
+
 =head1 SEE ALSO
 
-L<ssl(3)>,
+L<ssl(7)>,
 L<SSL_set_session_id_context(3)>
 
 =head1 HISTORY