Project

General

Profile

Actions

Bug #8758

closed

Add initial documentation for SSLServer

Added by lisukorin (Rafał Lisowski) over 10 years ago. Updated over 10 years ago.

Status:
Closed
Assignee:
Target version:
-
ruby -v:
2.0.0-p247
[ruby-core:<unknown>]

Description

In last few days I was struggling with SSLServer, so I decide to add some documentation to that class. Here is my first attempt to describe how use it.


Files

Updated by zzak (zzak _) over 10 years ago

  • Status changed from Open to Assigned
  • Assignee changed from drbrain (Eric Hodel) to zzak (zzak _)

Feel free to assign doc patches to me, I love them!

Updated by zzak (zzak _) over 10 years ago

@lisukorin (Rafał Lisowski) For #to_io I would say "..passed as the first argument to ::new"

I also think 'start_immediately' is implementation and should just be :nodoc:'d

Can you show me how to use your example in the overview? I tried a few ways to self-sign a cert, but none of them worked with your script.

Also, I think its "Secure Socket Layer", you have "Secure Sockets Layer" in the overview?

Updated by lisukorin (Rafał Lisowski) over 10 years ago

Hi Zachary,
Sorry for late reply.
I agree with your remarks. I will try to provide more detaled instruction and new patch tomorrow.

Updated by lisukorin (Rafał Lisowski) over 10 years ago

I took me a while (usually I use openssl to generate certs) but I create a Ruby Class which can be used to generate certs.
It's quite big. I am not sure if we should include it in documentation. You can see it here https://gist.github.com/korin/6423967#file-cert_generator-rb

Updated by zzak (zzak _) over 10 years ago

I'm going to skip the generator part, its a little verbose for my liking. Thank you for the patch, I will commit the other changes!

Updated by zzak (zzak _) over 10 years ago

  • Status changed from Assigned to Closed
  • % Done changed from 0 to 100

I have committed the changes in r42995 but missed the bug number on the commit :(

Actions

Also available in: Atom PDF

Like0
Like0Like0Like0Like0Like0Like0