FOSSologyの使い方(スキャン手順)
はじめに
今回はFOSSologyの基本的な使い方(スキャン手順)について説明していきます。
※ツール自体の概要をまず知りたいという方はこちらの記事を参照ください。
※環境構築方法について知りたい方はこちらの記事を参照ください。
本記事では、手元にあるソースコードをFOSSologyで解析する流れについて順を追って説明します。
参考:テスト用インスタンス
FOSSologyはテスト用のインスタンスが提供されています。動作確認のみであれば、こちらを使用するのもよいかもしれません。
https://www.fossology.org/get-started/
Server URL: https://fossology.osuosl.org/
Login user name: fossy
Login password: fossy
※本環境は消されたり再インストールされたりするようですので、本番環境としては(絶対に)使用しないでください。
FOSSology前提バージョン
Version: [4.1.0.77], Branch: [master], Commit: [#4f1059] 2022/09/02 10:27 +00:00 built @ 2022/09/02 10:32 +00:00
それではいきましょう。
解析の流れ
ログイン
まずFOSSologyにブラウザーでアクセスしてログインします。デフォルトのユーザー名とパスワードはそれぞれ「fossy」「fossy」です。
アップロード先フォルダの作成
続いて手元にあるソースコードをFOSSologyにアップロードするためのフォルダを作成します。画面上のメニューからOrganize→Folders→Createを選択します。
表示された画面で、アップロード先となるフォルダを作成します。フォルダ名および説明を入力してCreateを押下すると、フォルダが作成されます。
作成されたフォルダは、画面上のメニューからBrowseを選択すると確認できます。
アップロード&解析の設定
画面上のメニューから Upload→From File を選択します。
本画面で、解析対象ソースコードのアップロードと各種解析設定を実施します。
アップロードするフォルダの選択
先ほど作成したフォルダ(TestFolder)を選択します。
解析対象ソースコードの選択
解析対象となるソースコードを選択します。今回はサンプルとしてこちらのソースを使います。
https://github.com/square/okhttp/tree/parent-4.9.3
必要に応じてアップロードしたファイルの説明(Description)を入力します。
解析の設定
どのような解析をおこなうかを設定します。今回はSoftware Heritage Analysis以外すべて選択して進めます。その他、必要に応じて各種設定の選択またはチェックをおこない、最後にUploadボタンを押下します。
参考:FOSSologyの解析オプション(エージェント)の詳細
アップロードおよびスキャンが始まります。
解析結果の確認
ジョブ
画面上のメニューから Jobs→My Recent Jobs を選択します。
解析ジョブの状態を確認できます。すべてのステータスがCompletedになったら解析完了です。
解析結果
画面上のメニューからBrowseを選択し、画面左のFolder Navigationでアップロード先フォルダ(TestFolder)を選択すると、アップロード(スキャン)済みのファイルが表示されます。対象のファイルをクリックします。
解析結果が表示されます。
さいごに
以上がFOSSologyの解析手順になります。
FOSSologyの通常フローでは解析後に結果確認とクリアリングをおこないます。結果確認の方法について別の機会に書ければと思います。