step.yml

title: |-
  Connect to OpenVPN Server
summary: |
  Establish a VPN connection with the specified OpenVPN server.
description: |
  Before using this step, you need to build an OpenVPN server in advance.
  This article is helpful for how to construct OpenVPN server.
  https://www.digitalocean.com/community/tutorials/how-to-set-up-an-openvpn-server-on-ubuntu-18-04


  After building the VPN server, you need to register the contents of CA certificate, client certificate, client private key, base64 encoded as Bitrise Secret.
  You can easily retrieve the contents of Base64 with the following command.

  `$ base64 <certificate or private key file path>`
website: https://github.com/justice3120/bitrise-step-open-vpn
source_code_url: https://github.com/justice3120/bitrise-step-open-vpn
support_url: https://github.com/justice3120/bitrise-step-open-vpn/issues
host_os_tags:
  - osx-10.10
  - ubuntu-16.04

type_tags:
  - access-control

is_requires_admin_user: true
is_always_run: false
is_skippable: false
run_if: ""

deps:
  brew:
  - name: openvpn
  apt_get:
  - name: openvpn
  - name: net-tools


toolkit:
  bash:
    entry_file: step.sh

inputs:
  - host:
    opts:
      title: "Host"
      summary: "Open VPN Server IP or Hostname"
      description: |
        Open VPN Server IP or Hostname.
        ex1. 111.111.111.111
        ex2. hoge.com
      is_expand: true
      is_required: true
  - port: 1194
    opts:
      title: "Port"
      summary: "Open VPN Server Port number"
      is_expand: true
      is_required: true
  - proto: udp
    opts:
      title: "Protocol"
      summary: "Open VPN Server Protocol"
      is_expand: true
      is_required: true
      value_options:
        - udp
        - tcp
  - ca_crt: "$VPN_CA_CRT_BASE64"
    opts:
      title: "Base64 encoded CA Certificate"
      summary: "Base64 encoded CA Certificate"
      is_expand: true
      is_required: true
      is_sensitive: true
  - client_crt: "$VPN_CLIENT_CRT_BASE64"
    opts:
      title: "Base64 encoded Client Certificate"
      summary: "Base64 encoded Client Certificate"
      is_expand: true
      is_required: true
      is_sensitive: true
  - client_key: "$VPN_CLIENT_KEY_BASE64"
    opts:
      title: "Base64 encoded Client Private Key"
      summary: "Base64 encoded Client Private Key"
      is_expand: true
      is_required: true
      is_sensitive: true