Skip to content

Commit

Permalink
Merge branch 'main' into mobiletf/pm-7253/mobile-native-docs
Browse files Browse the repository at this point in the history
# Conflicts:
#	docs/architecture/mobile-clients/android/index.md
#	docs/architecture/mobile-clients/ios/index.md
#	docs/architecture/mobile-clients/net-maui-legacy/index.mdx
#	docs/architecture/mobile-clients/net-maui-legacy/overview.md
#	docs/architecture/mobile-clients/net-maui-legacy/watchOS.md
#	docs/getting-started/mobile/android/index.md
#	docs/getting-started/mobile/ios/index.md
#	docs/getting-started/mobile/net-maui-legacy/android/index.md
#	docs/getting-started/mobile/net-maui-legacy/index.md
#	docs/getting-started/mobile/net-maui-legacy/ios/index.mdx
#	docs/getting-started/mobile/net-maui-legacy/watchos/index.mdx
  • Loading branch information
fedemkr committed Aug 13, 2024
2 parents 72cf632 + d1f0edf commit 0aaa2a7
Show file tree
Hide file tree
Showing 24 changed files with 120 additions and 22 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/scan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
ref: ${{ github.event.pull_request.head.sha }}

- name: Scan with Checkmarx
uses: checkmarx/ast-github-action@4c637b1cb6b6b63637c7b99578c9fceefebbb08d # 2.0.30
uses: checkmarx/ast-github-action@1fe318de2993222574e6249750ba9000a4e2a6cd # 2.0.33
env:
INCREMENTAL:
"${{ contains(github.event_name, 'pull_request') && '--sast-incremental' || '' }}"
Expand All @@ -45,7 +45,7 @@ jobs:
--output-path . ${{ env.INCREMENTAL }}
- name: Upload Checkmarx results to GitHub
uses: github/codeql-action/upload-sarif@2d790406f505036ef40ecba973cc774a50395aac # v3.25.13
uses: github/codeql-action/upload-sarif@eb055d739abdc2e8de2e5f4ba1a8b246daa779aa # v3.26.0
with:
sarif_file: cx_result.sarif

Expand Down
1 change: 1 addition & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ keypair
keyserver
Kubebuilder
LDIF
libmagic
LLDB
Mailcatcher
minio
Expand Down
6 changes: 3 additions & 3 deletions docs/architecture/mobile-clients/net-maui-legacy/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ sidebar_position: 5

:::warning Legacy

Documentation of the **legacy** mobile app architecture done in .NET MAUI.
This represents the **legacy** mobile app architecture done in .NET MAUI.

:::

The mobile .NET MAUI clients are Android, iOS with its extensions and watchOS. They all are located
in this [Git repository](https://github.com/bitwarden/mobile).
The mobile .NET MAUI clients are Android and iOS applications with extensions and watchOS. They are
all located at https://github.com/bitwarden/mobile.

Principal structure is a follows:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 1

:::warning Legacy

Documentation of the **legacy** mobile app overview architecture done in .NET MAUI.
This represents the **legacy** mobile app overview architecture done in .NET MAUI.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

:::warning Legacy

Documentation of the **legacy** watchOS app architecture done in .NET MAUI.
This represents the **legacy** watchOS app architecture done in .NET MAUI.

:::

Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started/business/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
label: "Business apps"
position: 6
105 changes: 105 additions & 0 deletions docs/getting-started/business/splunk-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Splunk app

The Bitwarden Splunk app fetches event log data from the Bitwarden Public API and makes it available
in Splunk.

## Requirements

- Docker. If you're using an Apple Silicon Mac, enable _Docker Desktop_ -> _Settings_ -> _General_
-> _Use Rosetta for x86_64/amd64 emulation on Apple Silicon_
- Python 3.7 - 3.10
- [Poetry][poetry]
- libmagic (macOS only), available via homebrew: `brew install libmagic`
- A Bitwarden Teams or Enterprise organization
- If using a local development server - make sure the Events and EventsProcessor projects are
running and [Event Logging](../server/events.md) is working

## Set up and configuration

### Configure your environment

1. Clone the Github repository:

```
git clone https://github.com/bitwarden/splunk.git
```

2. Navigate to the root of the repository:

```
cd splunk
```

3. Tell poetry to use the required Python version:

```
poetry env use <executable>
```

Where `<executable>` is the executable for Python. If this is in your PATH variable then you do
not need to specify the full path. e.g. `poetry env use python3.8`

4. Activate the poetry shell:

```
poetry shell
```

5. Install dependencies:

```
poetry install --with dev
```

### Set up Splunk Enterprise

1. Run Splunk Enterprise:

```
docker run --rm --platform linux/amd64 --name splunk -d -p 8001:8000 -p 8089:8089 -e SPLUNK_START_ARGS='--accept-license' -e SPLUNK_PASSWORD='password' splunk/splunk:latest
```

Please note this will set the admin password to `password`. This is for development purposes
only.

2. Confirm that Splunk is running by navigating to http://localhost:8001

### Deploy the app

1. Package the app:

```
./package.sh
```

This will produce a packaged Splunk app in `output/bitwarden_event_logs.tar.gz`

2. Deploy the app to Splunk:

```
./deploy.sh
```

This will restart Splunk and it may take a few seconds to become available again after the script
is finished

3. (optional) Check the logs for errors or for debugging purposes later:
```
docker exec -u splunk -it splunk tail -f /opt/splunk/var/log/splunk/bitwarden_event_logs_beta.log
```

### Configure the app in Splunk

1. Navigate to the Splunk web app: http://localhost:8001

2. Log in with the username `admin` and the password `password`

3. Click on the _Apps_ -> _Bitwarden Event Logs_

4. Complete the setup. Refer to the [Bitwarden Help Center][Bitwarden Splunk SIEM] for more
information about configuration

You should now see your organization events in _Apps_ -> _Bitwarden Event Logs_ -> _Dashboards_.

[Bitwarden Splunk SIEM]: https://bitwarden.com/help/splunk-siem/
[poetry]: https://python-poetry.org/docs/#installation
2 changes: 0 additions & 2 deletions docs/getting-started/enterprise/_category_.yml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/getting-started/mobile/android/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Android

This section documents how to get started with the Android Bitwarden project in Kotlin.
How to get started with the Android Bitwarden project in Kotlin.

## Repository

Expand Down
8 changes: 0 additions & 8 deletions docs/getting-started/mobile/ios/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,3 @@ the script to the `.git/hooks` directory.
```sh
$ cp Scripts/pre-commit .git/hooks/
```

## Compatibility

- **Minimum iOS**: 15.0
- **Target SDK**: 15.0
- **Device Types Supported**: iPhone, iPad
- **Screen Sizes Supported**: iPhone SE to iPhone 15 Pro Max, iPad Mini to iPad Pro 12.9"
- **Orientations Supported**: Portrait, Landscape
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

:::warning Legacy

Documentation of the **legacy** Android app done in .NET MAUI.
Getting started the **legacy** Android app done in .NET MAUI.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/mobile/net-maui-legacy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 4

:::warning Legacy

Documentation of the **legacy** mobile app done in .NET MAUI.
Getting started the **legacy** mobile app done in .NET MAUI.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/mobile/net-maui-legacy/ios/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem";

:::warning Legacy

Documentation of the **legacy** iOS app done in .NET MAUI.
Getting started the **legacy** iOS app done in .NET MAUI.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_custom_props:

:::warning Legacy

Documentation of the **legacy** watchOS app done in .NET MAUI.
Getting started the **legacy** watchOS app done in .NET MAUI.

:::

Expand Down

0 comments on commit 0aaa2a7

Please sign in to comment.