https://github.com/Asmod4n/mruby-tls
mruby wrapper for libtls from http://www.libressl.org/
https://github.com/Asmod4n/mruby-tls
libressl mruby ssl tls
Last synced: 6 months ago
JSON representation
mruby wrapper for libtls from http://www.libressl.org/
- Host: GitHub
- URL: https://github.com/Asmod4n/mruby-tls
- Owner: Asmod4n
- License: apache-2.0
- Created: 2015-01-13T05:52:11.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T13:24:14.000Z (about 1 year ago)
- Last Synced: 2024-11-12T17:48:58.590Z (6 months ago)
- Topics: libressl, mruby, ssl, tls
- Language: C
- Homepage:
- Size: 53.7 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mruby - mruby-tls - mruby wrapper for libtls from http://www.libressl.org/. (Networking)
README
# mruby-tls
Prerequisites
=============
[libtls](https://www.libressl.org) needs to be somewhere the mruby compiler can find it.
For example on macOS you need to add the folowing to your build_config.rb after installing it with
```brew install libressl```
```ruby
conf.gem mgem: 'mruby-tls' do |spec|
spec.cc.include_paths << '/usr/local/opt/libressl/include'
spec.linker.library_paths << '/usr/local/opt/libressl/lib'
end
```
By default libtls looks in /etc/ssl/cert.pem for ca certs, you can find how to change that in the examples below.
Client example with blocking IO
================================
```ruby
client = Tls::Client.new
client.connect('github.com:443').write("GET / HTTP/1.1\r\nHost: github.com\r\nConnection: close\r\n\r\n")
print client.read
client.close
```
Its also possible to connect via service descriptions.
```ruby
client.connect('github.com', 'https')
```
You can also use port numbers as the second Argument.
```ruby
client.connect('github.com', '443')
```
If your ca certs are in another path.
```ruby
client = Tls::Client.new(ca_file: '/usr/local/etc/libressl/cert.pem')
```
If you later want to change a config setting
```ruby
client.config.ca_file = '/etc/ssl/cert.pem'
```
Client example with non blocking IO
====================================
requires mruby-poll gem
```ruby
tcp_socket = TCPSocket.new "github.com", 443
client = Tls::Client.new
client.connect_socket tcp_socket.fileno, "github.com"
tcp_socket._setnonblock(true)
poll = Poll.new
tcp_socket_pi = poll.add(tcp_socket, Poll::Out)
buf = "GET / HTTP/1.1\r\nHost: github.com\r\nConnection: close\r\n\r\n"
while buf
unless poll.wait
raise "Can't write to socket"
end
tmp = client.write_nonblock(buf)
case tmp
when :tls_want_pollin
tcp_socket_pi.events = Poll::In
when :tls_want_pollout
tcp_socket_pi.events = Poll::Out
when Fixnum
buf = buf[tmp+1...-1]
end
end
tcp_socket_pi.events = Poll::In
poll.wait
until (buf = client.read_nonblock()).is_a? String
case buf
when :tls_want_pollin
tcp_socket_pi.events = Poll::In
when :tls_want_pollout
tcp_socket_pi.events = Poll::Out
end
unless poll.wait
raise "Can't read from socket"
end
end
puts buf
tcp_socket._setnonblock(false)
client.close
tcp_socket.close
```
Configuration Examples
======================
You can create a configuration object to share with several connections.
```ruby
config = Tls::Config.new # see https://github.com/Asmod4n/mruby-tls/blob/master/mrblib/config.rb for options.
client = Tls::Client.new config
```
You can later on change the configuration object
```ruby
client.config = config
```
Server example
==============
```sh
openssl ecparam -name secp256r1 -genkey -out private-key.pem
openssl req -new -x509 -key private-key.pem -out server.pem
```
```ruby
tls_server = Tls::Server.new(key_file: 'private-key.pem', cert_file: 'server.pem')
tcp_server = TCPServer.new 5000 # requires mruby-socket
tcp_client = tcp_server.accept
tls_client = tls_server.accept_socket tcp_client.fileno
tls_client.write "hallo\n"
tls_client.close
```
Client Connections don't have a configurable config at the moment
This maps the C Api 1:1, to get a overview http://www.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man3/tls_accept_fds.3?query=tls%5finit&sec=3 is a good starting point.
License
=======
Copyright 2015,2016,2024 Hendrik Beskow
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this project except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.