cats_dogsシリーズの全体像

2024年05月30日 木曜日


【この記事を書いた人】
ふぇにっくちゅん(守田 瞬)

2021年11月にセキュリティ情報統括室に所属。頑固なので、ニックネームだけでもやわらかくひらがなにしてみました。普段はハニーポットで収集したDDoSの発生源であるマルウェアを対象に分析しています。

「cats_dogsシリーズの全体像」のイメージ

この記事は、以前に公開したcats_dogs(キャッツ・ドッグス)に加え、今回新たに公開したcats_pr_dogs(キャッツ・プレーリー・ドッグ)cats_eeds(キャッツ・シーズ)について紹介していきます。
cats_dogsシリーズは、GitHub上の1f408で公開しています。
既にご存知のものもあるかと思いますが、cats_pr_dogsを公開したタイミングで過去に公開していたもので、立場が変化しているものがあります。
また、数も多くなってきたため、一度ここでcats_dogsという言葉が何を表しているか?公開しているものはどんなものがあるのか?を整理しようと思います。

cats_dogsとは

cats_dogsは、Markdownで書いたファイルをブラウザで閲覧できるアプリです。
それ以外にも、閲覧権限を文単位で行える機能があります。
このcats_dogsは、サーバアプリとして稼働するモジュール群です。
これらのモジュールは、GitHub上にcats_dogsのリポジトリとして公開しています。

つまり、cats_dogsというのはリポジトリ名として説明していることもありますし、モジュールの総称として使用している時があります。
これは文脈から判断するしかありませんが、この記事では極力「モジュール群」や「リポジトリ」という言葉を添えて説明していきます。

リポジトリを管理している場所

このcats_dogsリポジトリは、GitHub上の1f408というOrganizationで管理しています。
1f408へアクセスすると、cats_dogs以外のリポジトリが確認できると思います。

公開物

今回新たに二つのリポジトリを公開しました。
それが、cats_pr_dogsとcats_eedsです。
それと同時に、以前から立場を変えたものがあり、それがcats_dogsです。
立場を変えたといっても、以前と表面上の変化はありません。
まずは、これら3つのリポジトリについて説明します。

cats_eedsリポジトリは以前のcats_dogsリポジトリで管理していたコードの一部を管理しています。
その一部とは、例えばMarkdownをHTMLに変換する処理のコードです。
つまり、cats_dogsのコアなコードをcats_eedsで管理するようにして、他のアプリでも活用できる様にしています。
言い換えると、cats_eedsで管理しているのは、Markdown処理エンジンのライブラリです。

そのため、cats_dogsはcats_eedsを用いた、サーバアプリのモジュール群という立場になりました。
コアな処理はcats_eedsに委ねており、サーバアプリとして稼働する箇所だけを担う構成になっています。

プレビューアプリのコードを管理しているcats_pr_dogsもコアな処理はcats_eedsに委ねています。
そのため、ローカルな環境でクライアントアプリとして稼働し、サーバをわざわざ構築しなくとも、Markdownの表示を確認できるようになりました。

全体構成

以下に、1f408で管理しているリポジトリを表にして示します。

リポジトリ名 カテゴリ 概要
cats_dogs サーバアプリ 情報共有するためのWebサーバで稼働するアプリ(モジュール群)
cats_pr_dogs クライアントアプリ Markdownファイルをプレビューするためのクライアントで稼働するアプリ
cats_eeds ライブラリ MarkdownをHTMLに変換する処理などのライブラリ
cats_ample ユーティリティ cats_dogsのサーバ構築で使用できる設定ファイルのサンプル
cat_om ユーティリティ Gitと連携してRSSフィードを生成するツール
cat_nofn ユーティリティ フォントデータを作成するツール

さいごに

今回のリリースによって、よりcats_dogsが使いやすい環境が実現できるようになりました。
好きなエディタで書きやすく、公開する前のチェックを容易にし、安心して文章を共有できるサーバを構築することができます。
あとは、cats_dogsのモジュールの組み合わせを考えてサーバを設計し、足りない機能を開発するなどして、さらに状況共有しやすい環境を目指してみてください。

ふぇにっくちゅん(守田 瞬)

2024年05月30日 木曜日

2021年11月にセキュリティ情報統括室に所属。頑固なので、ニックネームだけでもやわらかくひらがなにしてみました。普段はハニーポットで収集したDDoSの発生源であるマルウェアを対象に分析しています。

Related
関連記事