#### Linux```sh
# You may need to run sudo apt-get install python3-venv first
python3 -m venv .venv
source .venv/bin/activate

### المتطلبات
أذونات EntraID/M365 التالية مطلوبة لتشغيل Untitled Goose Tool، وهي تمنحه وصولاً للقراءة فقط إلى المستأجر (tenant).

يرجى ملاحظة: يجب أن يكون حساب المستخدم حسابًا سحابيًا فقط (غير مزامن مع البيئة المحلية on-premise)، وهذا يضمن بقاء عملية تسجيل الدخول كما هي عبر البيئات المختلفة للأداة.

حساب مستخدم سحابي فقط ومدير خدمة EXO (service principal) مرتبط به، مع الأذونات التالية:

مركز إدارة Exchange Online```
- View-Only Audit Logs
- View-Only Configuration 
- View-Only Recipients
- User Options

أدوار IAM لاشتراكات Azure```
- Reader
- Storage Blob Data Reader
- Storage Queue Data Reader

بالإضافة إلى ذلك، يمكن للبرنامج النصي حذف التطبيق عند الانتهاء من استخدامه.```powershell
PS > Write-Host "Creating a new Goose Application and Users"
PS > ./Create_SP.ps1 -AppName GooseApp -Delete

#### Docker```sh
docker build . -t goosey
docker run -it -v $PWD:/workdir goosey goosey honk --debug

سيتم إنشاء نسخة من هذا الأمر عند تشغيل سكربت تثبيت PowerShell لإنشاء/إعداد service principal. فيما يلي مثال بقيم معلمات وهمية.```sh
$ goosey conf --config_tenant=5fd146ad-8b31-4afa-a72f-6f71df5c7173 --config_subscriptionid=all --auth_appid=24fd6377-79e0-445d-838b-3eaa60d3ca21 

يبدو الإعداد الأساسي كما يلي:```
[config]
# The tenant ID of your AAD tenant
tenant=
# If you have a GCC High tenant
us_government=False
# If you have a GCC tenant with MDE
mde_gcc=False
# If you have a GCC High tenant with MDE
mde_gcc_high=False
# If your M365 tenant is a government tenant
exo_us_government=False
# If you want to check all of your Azure subscriptions, set this to All, otherwise enter your Azure subscription ID. For multiple IDs, separate it with commas, no spaces
subscriptionid=All

[filters]
# Format should be YYYY-MM-DD. If not set will default to the earliest date for log retention
date_start=
# Format should be YYYY-MM-DD. Will default to the present day
date_end=

[variables]
# Threshold used for ual API requests. Specifies the maximum results pulled per session. Can be between 100 - 50000. The api is optimized to return results faster the larger the threshold, but the whole session has to be repeated if an error occurs as the results are not returned sorted. We recommend 5000 as the threshold, but this can be toggled with
ual_threshold=5000
# Maximum number of ual coroutines/tasks to have running asynchronously. Minimum value is 1.
max_ual_tasks=5
# Start date for an extra time frame for ual to search. Reason for this is because ual takes the longest to pull and while you don't want the oldest data to roll off, you may want to look at another timeframe and do not want to wait for ual to get there and pull the logs. Format should be YYY-MM-DD
ual_extra_start=
# End date for an extra time frame for ual to search. Reason for this is because ual takes the longest to pull and while you don't want the oldest data to roll off, you may want to look at another timeframe and do not want to wait for ual to get there and pull the logs. Format should be YYY-MM-DD
ual_extra_end=
# Threshold for how many logs to pull per query. Usually want to try to max this out as KQL queries are rate limited.
mde_threshold=10000
# can be either 'table' or 'machine'. 'table' will pull directly from the mde tables without filtering. While 'machine' will filter by 'machine' with large tenants 'machine' will likely be prefered as time bounding on the entire table will likely cause issues.
mde_query_mode=table

[azure]
# Dumps activity log from azure
activity_log=False
# Returns all azure subscriptions
all_azure_subscriptions=False
# Dump insights bastion audit logs
bastion_logs=False
# Dump Azure configuration information
configs=False
# Dump D4IOT portal configs
d4iot_portal_configs=False
# Dump D4IOT portal pcaps from alerts
d4iot_portal_pcap=False
# Dump insights audit events for key_vault
key_vault_log=False
# Dump insights network security group flow events
nsg_flow_logs=False

[entraid]
# Dumps Entra ID Audit logs
entraid_audit=False
# Dumps Entra ID provisioning logs
entraid_provisioning=False
# Dumps Entra ID configuration files
configs=False
# Dumps risk detections from identity protection. Requires a minimum of Microsoft Entra ID P1 license and Microsoft Entra Workload ID premium license for full results.
risk_detections=False
# Dumps risky users and service principal information. Requires a minimum of Microsoft Entra ID P2 license and Microsoft Entra Workload ID premium license for full results.
risky_objects=False
# Dump security actions, alerts, and scores
security=False
# Dump interactive (adfs) sign in logs
signins_adfs=False
# Dump managed identity (msi) sign in logs
signins_msi=False
# Dump non-interactive (rt) sign in logs
signins_rt=False
# Dump service principal (sp) signin logs
signins_sp=False

[m365]
# Get Exchange discovery information
ediscovery_info=False
# Get all of the applications installed for the organization
exo_addins=False
# Get EXO config information
exo_config_info=False
# Dumps Exchange Online Role Group and Role Group Members information.
exo_groups=False
# Get all the messageRule objects defined for all users' inboxes
exo_inboxrules=False
# Dumps Exchange Online Mailbox Information
exo_mailbox=False
# Get information on m365 mobile devices
exo_mobile_devices=False
# Dumps UAL for last year using Search-UnifiedAuditLog api. Previous ual api is currently deprecated.
ual=False

[mde]
# Dumps the results from incidents and alerts.
advanced_hunting_alerts_incidents=False
# Dumps the results from advanced hunting queries.
advanced_hunting_query=False
# Dumps the results from advanced hunting API queries.
advanced_identity_hunting_query=False
# Dump alerts
alerts=False
# Dump indicators
indicators=False
# Dump investigations
investigations=False
# Dump library files
library_files=False
# Dump known machine vulnerabilities
machine_vulns=False
# Dump machines with mde
machines=False
# Dump mde recommendations
recommendations=False
# Dump known installed software
software=False

يبدو تكوين D4IoT كما يلي:```
[config]
# Enter your D4IoT sensor IP
d4iot_sensor_ip=
# Enter your D4IoT management console IP
d4iot_mgmt_ip=

[d4iot]
# Dump management alerts
mgmt_alerts=False
# Dump management devices
mgmt_devices=False
# Dump management sensor pcap captured
mgmt_pcap=False
# Dump management sensor information
mgmt_sensor_info=False
# Dump sensor alerts
sensor_alerts=False
# Collect all device connections
sensor_device_connections=False
# Dummp sensor device known cves
sensor_device_cves=False
# Dump sensor device known vulnerabilities
sensor_device_vuln=False
# Dump sensor devices
sensor_devices=False
# Dump sensor events
sensor_events=False
# Dump sensor operation vulnerabilities
sensor_operational_vuln=False
# Dump sensor pcap
sensor_pcap=False
# Dump sensor security vulnerabilities
sensor_security_vuln=False

شغّل بالإعدادات الافتراضية. بشكل افتراضي، سيقوم بتشفير بيانات الاعتماد/الرموز المميّزة باستخدام كلمة مرور يُطلب إدخالها. إذا لم تكن الحقول معرّفة في الإعدادات، فسيطلبها أيضًا:```sh
$ goosey auth

### Csv```sh
$ goosey csv --help
NAME
    goosey csv - Create csv files mapping GUIDs to text

SYNOPSIS
    goosey csv <flags>

DESCRIPTION
    Create csv files mapping GUIDs to text

FLAGS
    -o, --output_dir=OUTPUT_DIR
        Default: 'output/entraid/'
        The directory where the goose files are located
    -r, --result_dir=RESULT_DIR
        Default: 'output/csvs/'
        Directory for storing the results
    -d, --debug=DEBUG
        Default: False
        Enable debug logging

### Honk```sh
$ goosey honk --help
NAME
    goosey honk - Untitled Goose Tool Information Gathering

SYNOPSIS
    goosey honk <flags>

DESCRIPTION
    Untitled Goose Tool Information Gathering

FLAGS
    --authfile=AUTHFILE
        Default: '.ugt_auth'
        File to store the authentication tokens and cookies
    -c, --config=CONFIG
        Default: '.conf'
        Path to config file
    --auth=AUTH
        Default: '.auth'
        File to store the credentials used for authentication
    -o, --output_dir=OUTPUT_DIR
        Default: 'output'
        Directory for storing the results
    -r, --reports_dir=REPORTS_DIR
        Default: 'reports'
        Directory for storing debugging/informational logs
    --debug=DEBUG
        Default: False
        Enable debug logging
    --dry_run=DRY_RUN
        Default: False
        Dry run (do not do any API calls)
    --azure=AZURE
        Default: False
        Set all of the Azure calls to true
    --entraid=ENTRAID
        Default: False
        Set all of the Entra ID calls to true
    --m365=M365
        Default: False
        Set all of the M365 calls to true
    --mde=MDE
        Default: False
        Set all of the MDE calls to true

شغّل مع تفعيل تسجيل التصحيح، وأخرج إلى الدليل `my_outputs`، وفعّل جميع استدعاءات Azure:```sh
$ goosey honk --debug --output-dir my_outputs --azure

### سير العمل الافتراضي الموصى به

1. ثبّت الأداة `pip install .`
2. (اختياري) شغّل [سكربت PowerShell للإعداد](https://github.com/cisagov/untitledgoosetool/blob/develop/scripts/Create_SP.ps1) لإعداد service principal لمستأجرك
3. استخدم أمر `goosey conf` المُخرَج. أو شغّله فقط بدون معاملات
4. املأ ملف `.auth` ببيانات اعتمادك (إذا لم تستخدم مخرَج سكربت PowerShell)
5. املأ معلومات الإعداد واضبط الاستدعاءات المطلوبة في ملف `.conf` إلى `True`.
6. شغّل `goosey auth` بالمعاملات المطلوبة.
7. شغّل `goosey honk` بالمعاملات المطلوبة.
8. بدلاً من الخطوتين 6-7 شغّل `goosey autohonk` بالمعاملات المطلوبة

### سير العمل الموصى به لاستدعاء UAL

1. الخطوات من 1 إلى 4 أعلاه
2. افتح ملف `.conf` واضبط `ual` تحت قسم `m365` إلى `True`.
3. شغّل `goosey auth` بالمعاملات المطلوبة.
4. شغّل `goosey honk` بالمعاملات المطلوبة.
5. بدلاً من الخطوتين 3-4 شغّل `goosey autohonk` بالمعاملات المطلوبة

### اعتبارات

1. نوصي بتشغيل [سكربت PowerShell للإعداد](https://github.com/cisagov/untitledgoosetool/blob/develop/scripts/Create_SP.ps1) أو ملء ملف `.conf` أولاً
2. ملء ملف `.auth` و/أو `.auth_d4iot` أصبح اختياريًا الآن.
3. شغّل دائمًا `goosey auth` قبل تشغيل `goosey honk` أو `goosey d4iot`. سيقوم `goosey autohonk` بالمصادقة من تلقاء نفسه.

### حالات استخدام خاصة

#### خلف بروكسي

يجب أن تعمل الأداة خلف بروكسي (proxy). طالما تم تعيين متغيرات البيئة المناسبة لواجهة الأوامر (cli).```
https_proxy=<proxy_url>
http_proxy=<proxy_url>