racket/pkgs/net-doc/net/scribblings/osx-ssl.scrbl
Matthew Flatt 710320e3dc "Mac OS X" -> "Mac OS"
Although "macOS" is the correct name for Apple's current desktop OS,
we've decided to go with "Mac OS" to cover all of Apple's Unix-like
desktop OS versions. The label "Mac OS" is more readable, clear in
context (i.e., unlikely to be confused with the Mac OSes that
proceeded Mac OS X), and as likely to match Apple's future OS names
as anything.
2016-12-23 12:18:36 -07:00

43 lines
1.3 KiB
Racket

#lang scribble/doc
@(require "common.rkt"
(for-label net/osx-ssl
openssl))
@title[#:tag "osx-ssl"]{Mac OS Native SSL: Secure Communication}
@defmodule[net/osx-ssl]{The @racketmodname[net/osx-ssl] module
offers a fraction of the functionality of @racketmodname[openssl] and
works only on Mac OS, but it has the advantage that it works before
OpenSSL libraries are installed.}
@history[#:added "6.3.0.12"]
@defproc[(osx-ssl-connect [hostname string?]
[port-no (integer-in 1 65535)]
[client-protocol
(or/c 'secure 'auto
'sslv2-or-v3 'sslv2 'sslv3 'tls 'tls11 'tls12)
'auto])
(values input-port?
(and/c output-port? osx-ssl-output-port?))]{
Like @racket[ssl-connect], but without support for client contexts.}
@defproc[(osx-ssl-abandon-port [in osx-ssl-output-port?]) void?]{
Analogous to @racket[ssl-abandon-port].}
@defproc[(osx-ssl-output-port? [v any/c]) boolean?]{
Returns @racket[#t] of @racket[v] is an SSL output port produced by
@racket[osx-ssl-connect].}
@defproc[(osx-old-openssl?) boolean?]{
Returns @racket[#t] if the OpenSSL library currently accessed by
@racketmodname[openssl] is too old, in which case
@racket[osx-ssl-connect] should be preferred.}