rabbit-slide-unasuke-ruby-association-2022-grant-accomplishment-report 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1e45907f943f90144fa6733ed6ca640cdca2248f5b8bedc3b40f87f89a9528d
+  data.tar.gz: b299b50dfd96ee9a7bf50688ad9878a49ac2eca01ff498aba7e29fe942b63b7c
+SHA512:
+  metadata.gz: e4c6396b079a731647902ac86ca915f40539d398e8390553c8eb9bbd0e7152d4f53bea26a6f4d57afebae2f9cdd068029e007048d7d7813a894b633155030fcb
+  data.tar.gz: 7c612d15daff96e69797766220922b104f3fa006fd26c9697d2b8d29ac0a980a20d3ace9747440b72a66f90d48e23cfe45e061943af8deae2391d21d043f4428

data/.rabbit

@@ -0,0 +1,2 @@
+--size 1920,1080
+slide.md

data/README.md

@@ -0,0 +1,24 @@
+# Ruby Association 2022 grant accomplishment report
+
+https://www.ruby.or.jp/ja/news/20230710_2
+
+## 作者向け
+
+### 表示
+
+    rake
+
+### 公開
+
+    rake publish
+
+## 閲覧者向け
+
+### インストール
+
+    gem install rabbit-slide-unasuke-ruby-association-2022-grant-accomplishment-report
+
+### 表示
+
+    rabbit rabbit-slide-unasuke-ruby-association-2022-grant-accomplishment-report.gem
+

data/Rakefile

@@ -0,0 +1,17 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  # spec.files += Dir.glob("doc/**/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+  # spec.add_runtime_dependency("rabbit-theme-YOUR-THEME")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/config.yaml

@@ -0,0 +1,23 @@
+---
+id: ruby-association-2022-grant-accomplishment-report
+base_name: slide
+tags: []
+presentation_date:
+presentation_start_time:
+presentation_end_time:
+version: 1.0.0
+licenses: []
+slideshare_id:
+speaker_deck_id:
+vimeo_id:
+youtube_id:
+width: 1920
+height: 1080
+source_code_uri: https://github.com/unasuke/ruby-association-2022-grant-accomplishment-report
+author:
+  markup_language: :markdown
+  name: unasuke
+  email: yusuke1994525@gmail.com
+  rubygems_user: unasuke
+  slideshare_user:
+  speaker_deck_user:

data/slide.md

@@ -0,0 +1,216 @@
+# RubyによるQUICプロトコルの\\n他言語からの移植ならびに\\n独自実装の作成
+
+author
+:  unasuke (Yusuke Nakamura)
+
+content-source
+:  Ruby Association Activity Report
+
+date
+:  2023-08-28
+
+theme
+:  theme
+
+# 自己紹介
+
+* Name: unasuke (Yusuke Nakamura)
+* Work: フリーランス
+* Kaigi on Rails オーガナイザー (10/27-28 開催)
+* {::tag name='x-small'}GitHub <https://github.com/unasuke>{:/tag}
+* {::tag name='x-small'}ActivityPub <https://mstdn.unasuke.com/@unasuke>{:/tag}
+* {::tag name='x-small'}X (Twitter) <https://twitter.com/yu_suke1994>{:/tag}
+* {::tag name='x-small'}<https://unasuke.com>{:/tag}
+
+![](img/icon.jpg){:relative_width='24' align='right' relative_margin_right='-8' relative_margin_top='35'}
+
+
+# RubyによるQUICプロトコルの他言語からの移植ならびに独自実装の作成
+
+* 目的1: aioquicをRubyに移植する
+* 目的2: 移植の知見からRubyishなQUIC実装を作成する
+
+# QUICとは何か
+* RFC 9000を含む複数のRFCによって標準化された通信プロトコル
+* UDPの上にTCPのような信頼性のある通信を実現する
+* TLSが組み込まれており、セキュアな通信がデフォルトとなっている
+
+# QUICとは何か - Protocol Stack
+
+![](img/protocol-stack-h2-h3-improved-readability.png){:relative_width='45'}
+
+{:.center}
+{::tag name='x-small'}image from <https://github.com/rmarx/h3-protocol-stack>{:/tag}
+
+# aioquicとは何か
+* <https://github.com/aiortc/aioquic>
+* PythonによるQUIC実装
+* async/await構文を使用している
+
+# 既存実装
+* <https://github.com/quicwg/base-drafts/wiki/Implementations>
+  * IETF QUIC WG wikiにおけるQUICの実装一覧
+* C, C++, Go, Rust, Haskell, Python, Java等
+  * no Ruby
+
+# 移植の動機
+* QUICのRuby実装が存在しない
+* Ractorの大規模採用例があるとよいのではないか
+
+# そもそも移植は可能なのか
+
+![](img/aioquic-loc.png){:relative_width="95"}
+
+{:.center}
+aioquicの実装言語比率
+
+# aioquicの依存関係
+* <https://pypi.org/project/certifi/> 証明書を提供する
+* <https://pypi.org/project/pyOpenSSL/> OpenSSL
+  * <https://pypi.org/project/cryptography/>
+* <https://pypi.org/project/pylsqpack/> QPACK
+  * <https://github.com/litespeedtech/ls-qpack/>
+
+# aioquicの構造
+
+```
+$ tree src
+src
+├── aioquic
+│   ├── about.py
+│   ├── asyncio
+│   │   ├── client.py
+│   │   ├── __init__.py
+│   │   ├── protocol.py
+│   │   └── server.py
+│   ├── _buffer.c
+│   ├── buffer.py
+│   ├── _crypto.c
+│   ├── _crypto.pyi
+│   ├── quic
+│   │   ├── configuration.py
+│   │   ├── connection.py
+│   │   ├── crypto.py
+│   │   ├── events.py
+│   │   ├── __init__.py
+│   │   ├── logger.py
+│   │   ├── packet_builder.py
+│   │   ├── packet.py
+│   │   ├── rangeset.py
+│   │   ├── recovery.py
+│   │   ├── retry.py
+│   │   └── stream.py
+│   └── tls.py
+...
+```
+
+# buffer.c, buffer.pyi
+* C言語によるBuffer領域の実装をPython Objectにしたもの
+* mallocした領域に対する操作をPythonから行える
+* → StringIOをwrapするClassを作成して移植
+
+
+# packet.py, packet_builder.py
+* Packetそのものを表現したり構築するclass群
+* → ほぼそのままClass及びStructに移植
+
+# crypto.py, _crypto.c, _crypto.pyi
+* QUICのPacketそのものを暗号化するclass群
+* OpenSSLのAPIを利用するC実装も含む
+* openssl gem側でのAPIを調査してPure Rubyに移植
+
+# tls.py
+* TLS 1.3の(ほぼ)Pure Python実装
+  * 鬼門(1800行)
+* →ほぼそのまま移植した
+
+# OpenSSL APIの差異
+* PythonとRubyでOpenSSL APIをどのように抽象化するかが異なる
+* Python側はほぼCと1対1
+* Ruby側は扱いやすいように抽象化されている
+
+# OpenSSL APIの差異 Python側
+
+![](img/key_exchange_python.png){:relative_width='95'}
+
+# OpenSSL APIの差異 Ruby側
+
+![](img/key_exchange_ruby.png){:relative_width='95'}
+
+# connection.py
+* QUICのどのPacketを実際に取り扱う通信部分
+  * 鬼門(3200行)
+* →ほぼそのまま移植した(テストケース未完走)
+
+# 最終報告時点の成果
+
+![](img/raioquic-loc.png){:relative_width='95'}
+
+
+# 最終報告時点の成果
+* <https://github.com/unasuke/raioquic>
+  * 11000行
+* aioquic, quic-goとの簡単な通信ができることを確認
+
+# やらなかったこと
+* connection.rbのテストケース完走
+* 実際にリクエストを受け付ける部分の移植
+  * asyncioを使用している部分
+* Rubyishな実装の作成
+
+# 得られた知見
+* PythonとRubyの言語の差
+* QUIC及びTLS 1.3に対する理解
+
+# その後の活動
+* RubyKaigi 2023登壇
+  * <https://rubykaigi.org/2023/presentations/yu_suke1994.html>
+* IETF Meetingに参加
+  * 116 Yokohama
+  * 117 San Francisco (remote)
+* Rubyishな実装の作成
+  * RubyKaigi 2023 follow up
+
+# Rubyishな実装の作成
+* APIをRubyishにする
+* Documentationをしっかりやる
+* `IO::Buffer` を使用してみる
+
+# Documentationをしっかりやる (HKDF)
+
+![](img/raiha-yard.png){:relative_width="75"}
+
+# `IO::Buffer` を使用してみる
+
+```ruby
+# Apply packet protection
+# @see https://www.rfc-editor.org/rfc/rfc9001.html#section-5.4
+def apply(plain_header, protected_payload)
+  packet_number_length = (plain_header.get_value(:U8, 0) & 0x03) + 1
+  packet_number_offset = plain_header.size - packet_number_length
+  @mask = mask(
+    protected_payload.slice(PACKET_NUMBER_LENGTH_MAX - packet_number_length).slice(0, SAMPLE_LENGTH)
+  )
+
+  buffer = IO::Buffer.for(plain_header.get_string + protected_payload.get_string).dup # make mutable
+  if buffer.get_value(:U8, 0) & 0x80 != 0
+    buffer.copy(buffer.slice(0, 1).xor!(IO::Buffer.for((@mask[0].unpack1("C*") & 0x0f).chr)))
+  else
+    buffer.set_value(:U8, 0, buffer.slice(0, 1).xor!(IO::Buffer.for((@mask[0].unpack1("C*") & 0x1f)).chr))
+  end
+  buffer.copy(
+    buffer.slice(
+      packet_number_offset, packet_number_length).xor!(IO::Buffer.for(@mask[1..packet_number_length])
+    ),
+    packet_number_offset
+  )
+  buffer
+end
+```
+
+# まとめ
+* 引き続きRubyishなQUIC実装の開発を進めていく
+* IETF Meetingに参加して最新動向を追っていく
+* 謝辞
+  * Ruby Association様
+  * 笹田耕一様(メンター)

data/theme.rb

@@ -0,0 +1,113 @@
+@default_foreground ||= @foreground
+@default_background ||= @background
+@default_shadow_color ||= @shadow_color
+
+# pp font_families
+font_color             = '#333'
+@default_font          = 'BIZ UDPGothic'
+@font_family           = find_font_family(@default_font)
+@bold_font             = @default_font
+@bold_font_family      = find_font_family(@bold_font)
+@monospace_font        = 'Cica'
+@monospace_font_family = find_font_family(@monospace_font)
+
+@xxxx_large_font_size = screen_size(10 * Pango::SCALE)
+@xxx_large_font_size  = screen_size(8 * Pango::SCALE)
+@xx_large_font_size   = screen_size(6 * Pango::SCALE)
+@x_large_font_size    = screen_size(4.5 * Pango::SCALE)
+@large_font_size      = screen_size(4 * Pango::SCALE)
+@normal_font_size     = screen_size(3.5 * Pango::SCALE)
+@small_font_size      = screen_size(3.2  * Pango::SCALE)
+@x_small_font_size    = screen_size(3 * Pango::SCALE)
+@xx_small_font_size   = screen_size(2.8 * Pango::SCALE)
+@xxx_small_font_size  = screen_size(2.5 * Pango::SCALE)
+@script_font_size            = @x_small_font_size
+@large_script_font_size      = @small_font_size
+@x_large_script_font_size    = @large_font_size
+@title_slide_title_font_size = @xxx_large_font_size
+
+@block_quote_fill_color = "#f8f8f8"
+@preformatted_fill_color = "#f8f8f8"
+@default_headline_line_color = font_color
+
+# @title_slide_background_image = 'img/title_bg.png'
+# @slide_background_image = 'img/bg.png'
+
+# set_foreground(@default_foreground)
+# set_background(@default_background)
+
+add_image_path("ruby-images")
+include_theme("default-icon")
+# include_theme("default-title-text")
+include_theme("default-text")
+include_theme("default-title-slide")
+include_theme("default-slide")
+include_theme("default-item-mark")
+include_theme("default-method-list")
+include_theme("default-preformatted")
+include_theme("default-block-quote")
+include_theme("default-foot-text")
+include_theme("default-description")
+include_theme("image")
+include_theme("table")
+include_theme("newline-in-slides")
+include_theme("per-slide-background-color")
+include_theme("background-image-toolkit")
+include_theme("per-slide-background-image")
+include_theme("body-background-image")
+include_theme("tag")
+include_theme("syntax-highlighting")
+include_theme("default-comment")
+
+include_theme("title-slide-background-image")
+include_theme("slide-background-image")
+
+match(TitleSlide, "*") do |elems|
+  elems.horizontal_centering = true
+  elems.prop_set("size", @large_font_size)
+  set_font_family(elems)
+end
+
+match(TitleSlide, Title) do |titles|
+  titles.prop_set("size", @title_slide_title_font_size)
+  titles.padding_bottom = @space * 2
+  titles.prop_set("weight", "SemiBold")
+end
+
+match(Slide, HeadLine) do |heads|
+  heads.prop_set("size", @large_font_size)
+  heads.prop_set("weight", "bold")
+end
+
+match(TitleSlide) do |slides|
+  # slides.margin_left = 900
+  slides.vertical_centering = true
+  slides.prop_set "foreground", font_color
+  slides.prop_set("weight", "bold")
+end
+match(TitleSlide, Subtitle) do |subtitle|
+  subtitle.margin_top = -20
+  subtitle.prop_set("size", @large_font_size)
+end
+match(TitleSlide, Author) do |author|
+  author.margin_top = 50
+  author.prop_set("size", @large_font_size)
+  author.prop_set("weight", "normal")
+end
+match(TitleSlide, Place) do |place|
+  place.prop_set("size", @small_font_size)
+end
+match(TitleSlide, "*") do |elems|
+  elems.horizontal_centering = true
+end
+
+match(TitleSlide, Date) do |dates|
+  dates.prop_set("size", @small_font_size)
+  # dates.prop_set("style", "italic")
+end
+
+match(TitleSlide, ContentSource) do |sources|
+  sources.prop_set("size", @small_font_size)
+  sources.margin_bottom = @space
+  # sources.prop_set("style", "italic")
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-unasuke-ruby-association-2022-grant-accomplishment-report
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- unasuke
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: https://www.ruby.or.jp/ja/news/20230710_2
+email:
+- yusuke1994525@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.md
+- Rakefile
+- config.yaml
+- img/aioquic-loc.png
+- img/icon.jpg
+- img/key_exchange_python.png
+- img/key_exchange_ruby.png
+- img/protocol-stack-h2-h3-improved-readability.png
+- img/raiha-yard.png
+- img/raioquic-loc.png
+- pdf/ruby-association-2022-grant-accomplishment-report-slide.pdf
+- slide.md
+- theme.rb
+homepage: https://slide.rabbit-shocker.org/authors/unasuke/ruby-association-2022-grant-accomplishment-report/
+licenses: []
+metadata:
+  source_code_uri: https://github.com/unasuke/ruby-association-2022-grant-accomplishment-report
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Ruby Association 2022 grant accomplishment report
+test_files: []