Team Password Manager

https://teampasswordmanager.com/docs/
Admin
Team Password Manager is a self-hosted password management solution that enables teams to securely...
Tokens:268,193
Snippets:1,423
Trust Score:8.2
Update:1 year ago
Show doc for...
Tokens:
Raw
### Access Team Password Manager Installer

Source: https://teampasswordmanager.com/docs/install

This is an example URL to access the Team Password Manager installer. Replace 'teampasswordmanager.mydomain.com' with your actual domain or server address where the files have been uploaded. This step initiates the setup process.

```http
http://teampasswordmanager.mydomain.com/index.php/install
```

--------------------------------

### Directory Listing Example

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

This command output shows the expected directory structure and permissions after creating the necessary folders and setting ownership for the Team Password Manager installation. It confirms that the 'public_html' directory is owned by the current user and has appropriate read/write/execute permissions.

```bash
myuser@myhostname:/var/www/html/tpm.mycompany.com$ ls -la
total 16
drwxr-xr-x 4 root   root   4096 Oct 24 18:28 .
drwxr-xr-x 3 root   root   4096 Oct 24 18:28 ..
drwxr-xr-x 2 root   root   4096 Oct 24 18:28 logs
drwxr-xr-x 2 myuser myuser 4096 Oct 24 18:28 public_html
```

--------------------------------

### Making a GET Request (Example)

Source: https://teampasswordmanager.com/docs/api-v5

An example using `curl` to demonstrate making a GET request to fetch a list of passwords using HTTP Basic Authentication.

```APIDOC
## GET /passwords Example

### Description
This example shows how to fetch a list of passwords using a GET request with HTTP Basic Authentication via `curl`.

### Method
GET

### Endpoint
```
https://tpm.mydomain.com/index.php/api/v5/passwords.json
```

### Request Example
```bash
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v5/passwords.json
```

### Notes
- Replace `username` and `password` with your Team Password Manager credentials.
- Replace `https://tpm.mydomain.com` with the actual URL of your Team Password Manager installation.
- The `-i` flag includes response headers in the output.
```

--------------------------------

### Install MySQL 8 Server on Ubuntu

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Installs the MySQL 8 server package using apt. After installation, it's recommended to run the security script to secure the MySQL installation by setting a root password and configuring other security parameters.

```bash
sudo apt install mysql-server
sudo mysql_secure_installation
```

--------------------------------

### Install SourceGuardian Loader for PHP

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Steps to install the SourceGuardian Loader by copying the extension file and updating the PHP configuration. Requires downloading the loader from SourceGuardian's website.

```bash
# Unzip loaders.linux-x86_64.zip
# Copy ixed.8.2.lin to /usr/lib/php/20220829
# Edit /etc/php/8.2/apache2/php.ini and add: extension=ixed.8.2.lin
$ sudo systemctl restart apache2
```

--------------------------------

### Running Docker Compose Application

Source: https://teampasswordmanager.com/docs/docker-compose

This command initiates the Docker Compose setup defined in the `docker-compose.yml` file. It downloads necessary images, creates and starts containers for Team Password Manager and MySQL in detached mode.

```bash
docker compose up -d
```

--------------------------------

### Install Apache Web Server

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Installs the Apache 2.4 web server on the Ubuntu system. Apache is a popular web server used to host websites and web applications.

```bash
sudo apt install apache2
```

--------------------------------

### Install and Configure ionCube Loader for PHP

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

This snippet demonstrates how to install the ionCube Loader extension for PHP. It involves downloading the loader, copying the SO file to the PHP extension directory, and updating the `php.ini` configuration file. Finally, it shows how to verify the installation using `phpinfo()` and restart the Apache web server.

```shell
$ sudo systemctl restart apache2
```

```php
<?php phpinfo();
```

--------------------------------

### Team Password Manager Configuration File Example (config.php)

Source: https://teampasswordmanager.com/docs/install-ubuntu-18

This PHP code snippet shows the essential configuration settings for Team Password Manager. It defines constants for the database hostname, username, password, and database name. These values should match the credentials created during the database setup.

```php
// MySQL Database server
define('CONFIG_HOSTNAME', 'localhost');

// User that accesses the database server, that should have all privileges on the database CONFIG_DATABASE
define('CONFIG_USERNAME', 'tpm_user');

// User password
define('CONFIG_PASSWORD', 'tpmPass%2020');

// Database for Team Password Manager. You must manually create it before installing Team Password Manager
define('CONFIG_DATABASE', 'tpm_database');
```

--------------------------------

### Verify PHP Installation with phpinfo()

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Creates a `phpinfo.php` file in the web root to verify PHP installation and its integration with Apache. Accessing this file via a web browser displays detailed PHP configuration information. It's recommended to delete this file after verification for security.

```php
<?php phpinfo();

```

--------------------------------

### Install MySQL 8 Server on Ubuntu

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Installs the MySQL 8 server package, which is the default for Ubuntu 20.04. After installation, run the security script to configure root password and security settings. This is a prerequisite for storing Team Password Manager data.

```bash
$ sudo apt install mysql-server
$ sudo mysql_secure_installation
$ sudo mysql
```

--------------------------------

### PHP SourceGuardian Loader Installation

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Installs the SourceGuardian loader for PHP, which is required to run encoded PHP applications. This involves downloading the loader, placing the extension file in the PHP extension directory, and configuring php.ini.

```shell
extension = ixed.7.4.lin
```

--------------------------------

### Verify PHP 8.2 Installation

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Checks the installed PHP version by running `php -v`. Also includes steps to create a `phpinfo.php` file in the web root to verify PHP's integration with the web server (Apache in this case) by accessing it through a web browser.

```bash
php -v
# Create /var/www/html/phpinfo.php with content:
# <?php phpinfo();
# Access via http://IP_ADDRESS/phpinfo.php
```

--------------------------------

### Quick Example using curl

Source: https://teampasswordmanager.com/docs/api-v4

Demonstrates how to make a GET request to fetch a list of passwords using curl with HTTP Basic Authentication.

```APIDOC
## Quick Example (curl)

This example shows how to fetch a list of passwords using `curl` with HTTP Basic Authentication.

```bash
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v4/passwords.json
```

Replace `username`, `password`, and `https://tpm.mydomain.com` with your actual credentials and Team Password Manager installation URL.
```

--------------------------------

### Copy SSL Certificate Files to Server Directories

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Commands to copy the obtained SSL certificate files (`.crt` and `.ca-bundle`) and the private key (`.key`) to their respective secure directories on the server. These directories are standard locations for SSL/TLS configurations.

```bash
# cp tpm_mycompany_com.crt /etc/ssl/certs/
# cp tpm_mycompany_com.ca-bundle /etc/ssl/certs/
# cp tpm.mycompany.com.key /etc/ssl/private/
# cp tpm.mycompany.com.csr /etc/ssl/private/
```

--------------------------------

### Update System and Install SSL Certificate Files

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Updates the system packages and installs necessary SSL certificate files to the appropriate directories. Ensures certificate files are owned by root and have restricted permissions.

```shell
# su - root
# apt update && apt upgrade
# mkdir /root/certs/ && cd /root/certs/
# openssl req -new -newkey rsa:2048 -nodes -keyout tpm.mycompany.com.key -out tpm.mycompany.com.csr
# cat tpm.mycompany.com.csr
# cp tpm_mycompany_com.crt /etc/ssl/certs/
# cp tpm_mycompany_com.ca-bundle /etc/ssl/certs/
# cp tpm.mycompany.com.key /etc/ssl/private/
# cp tpm.mycompany.com.csr /etc/ssl/private/
# rm /root/cert/tpm*
# chown -R root. /etc/ssl/private/tpm*
# chown -R root. /etc/ssl/certs/tpm*
# chmod -R 0600 /etc/ssl/private/tpm*
# chmod -R 0600 /etc/ssl/certs/tpm*
```

--------------------------------

### Install Fail2ban Intrusion Prevention

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Installs the fail2ban package, a security application that scans log files and bans IP addresses that show malicious signs. Basic configuration is applied by copying the default conf file.

```bash
sudo apt install fail2ban
sudo cp /etc/fail2ban/fail2ban.conf /etc/fail2ban/fail2ban.local
```

--------------------------------

### GET /passwords.json Example

Source: https://teampasswordmanager.com/docs/api-v3

An example using curl to fetch a list of passwords via the API using HTTP Basic Authentication.

```APIDOC
## GET /passwords.json

### Description
Fetches a list of passwords accessible by the authenticated user.

### Method
GET

### Endpoint
`/index.php/api/v3/passwords.json`

### Parameters
No specific path or query parameters are detailed in the overview for this basic request, but the endpoint implies resource filtering might be possible.

### Request Body
Not applicable for GET requests.

### Request Example (curl)
```bash
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v3/passwords.json
```

Replace `username`, `password`, and `https://tpm.mydomain.com` with your actual credentials and installation URL.

### Response
#### Success Response (200)
Returns a JSON array of password objects. The structure of each password object is not detailed in the overview.

#### Response Example
```json
{
  "example": "[JSON array of password objects]"
}
```
```

--------------------------------

### PHP Configuration for Apache with CGI/FastCGI

Source: https://teampasswordmanager.com/docs/install

These PHP configuration settings are for Apache 2 with CGI/FastCGI. It involves enabling a directive in php.ini for proper API and URL handling.

```ini
; in php.ini
cgi.fix_pathinfo=1
```

--------------------------------

### Create MySQL Database and User for Team Password Manager

Source: https://teampasswordmanager.com/docs/install

These SQL commands create a new database named 'tpm_database', a user 'tpm_user' with the password 'tpm_password', and grant all necessary privileges on the database to this user. This is essential for Team Password Manager to store its data.

```sql
CREATE DATABASE `tpm_database` CHARACTER SET utf8 COLLATE utf8_unicode_ci;
CREATE USER 'tpm_user'@'localhost' IDENTIFIED BY 'tpm_password';
GRANT ALL PRIVILEGES ON  `tpm_database`.* TO 'tpm_user'@'localhost';
FLUSH PRIVILEGES;
```

--------------------------------

### Configure Firewall with SSH and NTP Access

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Sets up the Uncomplicated Firewall (ufw) to allow SSH traffic for remote access and NTP for time synchronization. Enabling the firewall is a critical security measure.

```bash
sudo ufw allow ssh
sudo ufw enable
sudo ufw allow ntp
```

--------------------------------

### PHP Configuration for Apache with FPM/FastCGI

Source: https://teampasswordmanager.com/docs/install

These PHP configuration settings are for Apache 2 with FPM/FastCGI. It involves setting a constant in config.php and enabling a directive in php.ini for proper API and URL handling.

```php
define('TPM_URI_PROTOCOL', 'PATH_INFO');
```

```ini
; in php.ini
cgi.fix_pathinfo=1
```

--------------------------------

### Configure Hosts File

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Adds an entry to the system's hosts file to map a static IP address to a hostname and a domain name. This is crucial for accessing the Team Password Manager installation via its URL.

```bash
IP ADDRESS hostname tpm.mycompany.com
```

--------------------------------

### Update System Packages

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Ensures the system's package list is up-to-date and upgrades existing packages to their latest versions. This is a fundamental step before installing new software.

```bash
sudo apt update && sudo apt upgrade
```

--------------------------------

### Update System and Generate SSL Certificate Files

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Commands to update the system and generate a private key and Certificate Signing Request (CSR) using OpenSSL. Protect your private key as it is essential for your certificate's security.

```bash
# su - root
# apt update && apt upgrade
# mkdir /root/certs/ && cd /root/certs/
# openssl req -new -newkey rsa:4096 -nodes -keyout tpm.mycompany.com.key -out tpm.mycompany.com.csr
```

--------------------------------

### NGINX Configuration for Team Password Manager

Source: https://teampasswordmanager.com/docs/install

This configuration snippet is for NGINX servers and specifies how to handle requests for Team Password Manager. It directs requests to the index.php file if the requested resource is not found.

```nginx
location / {
	try_files $uri $uri/ /index.php;
}
```

--------------------------------

### Set Ownership and Permissions for SSL Files

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Commands to set the correct ownership (to root) and restrictive file permissions (0600) for the SSL certificate and private key files. This is a crucial security step to protect sensitive information.

```bash
# chown -R root. /etc/ssl/private/tpm*
# chown -R root. /etc/ssl/certs/tpm*
# chmod -R 0600 /etc/ssl/private/tpm*
# chmod -R 0600 /etc/ssl/certs/tpm*
```

--------------------------------

### Restart Apache Service

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Restarts the Apache web server service to apply the recently made configuration changes. This ensures the server is running with the updated settings.

```bash
sudo systemctl restart apache2
```

--------------------------------

### Example Response for Listing Favorite Passwords (API v2)

Source: https://teampasswordmanager.com/docs/api-v2-favorites

An example JSON response body for the GET /favorite_passwords.json endpoint, illustrating the structure of a favorite password object, including its ID, name, project details, notes, and other relevant information.

```JSON
[
  {
    "id": 68,
    "name": "Wordpress admin",
    "project": {
      "id": 12,
      "name": "www.fictionalgadgetsite.com"
    },
    "notes_snippet": "some notes\nother notes",
    "tags": "wordpress",
    "access_info": "http:\/\/www.fictionalgadgetsite.com\/wp-admin",
    "username": "admin_sg",
    "email": "",
    "archived": false,
    "favorite": true,
    "num_files": 1,
    "updated_on": "2014-07-23 18:18:28"
  },
  {
    "id": 175,
    "name": "Sample password",
    "project": {
      "id": 12,
      "name": "www.fictionalgadgetsite.com"
    },
    "notes_snippet": "Some notes \nAnother line of the notes",
    "tags": "tag1,tag2",
    "access_info": "https:\/\/www.google.com",
    "username": "thisisausername",
    "email": "ferran@ferranbarba.com",
    "archived": true,
    "favorite": true,
    "num_files": 0,
    "updated_on": "2014-07-23 18:18:06"
  }
]
```

--------------------------------

### Vagrantfile Configuration for Team Password Manager

Source: https://teampasswordmanager.com/docs/install-vagrant-virtualbox

This Vagrantfile defines the virtual machine's configuration, including hostname, CPU, memory, swap space, timezones, and database credentials for Team Password Manager. It's designed to work with a provision.sh script for automated setup.

```ruby
hostname = "teampasswordmanager"
server_cpus = "1"
server_memory = "1024"
server_swap = "false"
server_timezone = "UTC"
mysql_root_password = "Root15%A"
php_timezone = "UTC"

tpm_database = "tpm_database"
tpm_user = "tpm_user"
tpm_password = "tpm_password"
```

--------------------------------

### Configure Firewall for SSH and Enable

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Allows Secure Shell (SSH) traffic through the Uncomplicated Firewall (ufw) and then enables the firewall. This ensures remote access is permitted and the firewall is active.

```bash
sudo ufw allow ssh
sudo ufw enable
```

--------------------------------

### Install NGINX Web Server (Ubuntu)

Source: https://teampasswordmanager.com/docs/install-ubuntu-nginx

Installs the NGINX web server on Ubuntu systems using a PPA for the latest version. This command adds the repository, updates the package list, and installs the NGINX package.

```bash
sudo add-apt-repository ppa:ondrej/nginx
sudo apt update
sudo apt install nginx
```

--------------------------------

### Apache Configuration for Team Password Manager API

Source: https://teampasswordmanager.com/docs/install

This configuration directive is used for Apache servers, particularly when using the API. It's placed in the virtualhosts file or .htaccess to pass authorization headers.

```apache
SetEnvIf Authorization .+ HTTP_AUTHORIZATION=$0
```

--------------------------------

### Configure Database Credentials in config.php (PHP)

Source: https://teampasswordmanager.com/docs/install-windows-xampp-2014

This snippet shows how to define the database username, password, and database name within the `config.php` file for Team Password Manager. Ensure these values match your database setup.

```php
define('CONFIG_USERNAME', 'tpmuser');
define('CONFIG_PASSWORD', 'tpmpassword');
define('CONFIG_DATABASE', 'teampasswordmanager');
```

--------------------------------

### Configure Team Password Manager Database Connection

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

This code snippet shows the essential configuration settings for Team Password Manager's `config.php` file. It defines constants for the MySQL hostname, username, password, and database name, allowing the application to connect to the previously created database.

```php
// MySQL Database server
define('CONFIG_HOSTNAME', 'localhost');

// User that accesses the database server, that should have all privileges on the database CONFIG_DATABASE
define('CONFIG_USERNAME', 'tpm_user');

// User password
define('CONFIG_PASSWORD', 'tpmPass%2022');

// Database for Team Password Manager. You must manually create it before installing Team Password Manager
define('CONFIG_DATABASE', 'tpm_database');
```

--------------------------------

### MySQL: Create Database and User

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

These commands create a new MySQL database named 'tpm_database' and a user 'tpm_user' with the specified password. It also grants all privileges on the database to the user and flushes privileges. Note the use of `mysql_native_password` for compatibility with PHP.

```mysql
CREATE DATABASE `tpm_database` CHARACTER SET utf8 COLLATE utf8_unicode_ci;
CREATE USER 'tpm_user'@'%' IDENTIFIED WITH mysql_native_password BY 'tpmPass%2023';
GRANT ALL ON tpm_database.* TO 'tpm_user'@'%';
FLUSH PRIVILEGES;
```

--------------------------------

### Verify PHP Installation with phpinfo

Source: https://teampasswordmanager.com/docs/install-ubuntu-18

Creates a PHP file to display detailed information about the PHP installation. This is used to confirm that PHP is correctly installed and communicating with the web server (Apache).

```php
<?php phpinfo();
```

--------------------------------

### Get Server Hostname

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Retrieves the hostname of the current system. This is used to configure the hosts file for local domain resolution.

```bash
hostname
```

--------------------------------

### GET /passwords.json

Source: https://teampasswordmanager.com/docs/api-v4-authentication

Retrieves a list of passwords accessible by the authenticated user. This example demonstrates using HTTP Basic Authentication.

```APIDOC
## GET /passwords.json

### Description
This endpoint retrieves a list of all passwords that the authenticated user has permission to access. It is useful for fetching a user's entire password vault or a subset based on their roles and permissions within Team Password Manager.

### Method
GET

### Endpoint
`/api/v4/passwords.json`

### Parameters
No path or query parameters are required for this endpoint. Authentication is handled via HTTP Basic or HMAC authentication headers.

### Request Body
None

### Request Example (curl with HTTP Basic Auth)
```bash
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v4/passwords.json
```

### Response
#### Success Response (200)
Returns a JSON object containing an array of password entries.

- **passwords** (array) - An array of password objects.
  - **id** (integer) - The unique identifier for the password entry.
  - **name** (string) - The name or title of the password entry.
  - **username** (string) - The username associated with the password entry.
  - ... (other fields may be present depending on the password entry details)

#### Response Example
```json
{
  "passwords": [
    {
      "id": 1,
      "name": "Example Website Login",
      "username": "user@example.com",
      "url": "https://example.com",
      "notes": "This is a test password.",
      "created_at": "2023-10-27T10:00:00Z",
      "updated_at": "2023-10-27T10:00:00Z"
    },
    {
      "id": 2,
      "name": "Another Service Account",
      "username": "service_acc",
      "url": null,
      "notes": "Account for internal service.",
      "created_at": "2023-10-26T09:00:00Z",
      "updated_at": "2023-10-26T09:00:00Z"
    }
  ]
}
```
```

--------------------------------

### curl: Get Passwords with HTTP Basic Auth

Source: https://teampasswordmanager.com/docs/api-v4-authentication

An example of retrieving a list of passwords from the Team Password Manager API using HTTP Basic Authentication with curl. It includes necessary headers and the API endpoint.

```curl
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v4/passwords.json
```

--------------------------------

### PHP: Get Passwords with HTTP Basic Auth

Source: https://teampasswordmanager.com/docs/api-v4-authentication

A comprehensive PHP script demonstrating how to fetch a list of passwords from the Team Password Manager API using HTTP Basic Authentication. It handles request setup, execution, and response parsing.

```php
<?php	
  // Parameters
  $tpm_base_url = 'https://tpm.mydomain.com/index.php/'; // ending with /
  $req_uri = 'api/v4/passwords.json'; // GET /passwords.json
  $username = 'YOUR USERNAME';
  $password = 'YOUR PASSWORD';

  // Request headers
  $headers = array(	
    'Content-Type: application/json; charset=utf-8'
  );

  // Request
  $ch = curl_init($tpm_base_url . $req_uri);
  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
  curl_setopt($ch, CURLOPT_HEADER, TRUE); // Includes the header in the output
  curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password); // HTTP Basic Authentication
  $result = curl_exec($ch);	
  $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);	
  curl_close($ch);

  // Get headers and body
  list($headers, $body) = explode("\r\n\r\n", $result, 2);
  $arr_headers = explode("\r\n", $headers);
  $arr_body = json_decode($body, TRUE);

  // Show status and array of passwords
  echo 'Status: ' . $status . '<br/>';
  print_r($arr_body);
?>
```

--------------------------------

### Backup Team Password Manager Database using Command Line

Source: https://teampasswordmanager.com/docs/backup

This command-line utility is used to create a SQL backup file of the Team Password Manager database. It requires the database user credentials and the database name. The output is a .sql file containing the entire database structure and data.

```bash
mysqldump -uuser -ppassword tpm_database > backup_file.sql
```

--------------------------------

### Install PHP 7.4 and Required Modules on Ubuntu

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

Installs PHP 7.4 along with essential modules required for Team Password Manager, including CLI, MySQL, LDAP, cURL, and GD support. It also guides on checking the PHP version and configuring the timezone in php.ini.

```bash
$ sudo apt install php7.4 php7.4-cli php7.4-mysql php7.4-mbstring php7.4-ldap php7.4-curl php7.4-gd php7.4-xml
$ php -v
```

--------------------------------

### Quick Example using cURL

Source: https://teampasswordmanager.com/docs/api-v1

Demonstrates how to fetch a list of passwords using cURL with HTTP Basic Authentication.

```APIDOC
## Quick Example

This `curl` example fetches the list of passwords using HTTP Basic Authentication:

```bash
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v1/passwords.json
```

Replace `username`, `password`, and `https://tpm.mydomain.com` with your actual credentials and installation URL.
```

--------------------------------

### Install MySQL 5.7 Server

Source: https://teampasswordmanager.com/docs/install-ubuntu-18

Installs the MySQL 5.7 server package on Ubuntu. After installation, it guides through securing the installation by setting a root password, removing anonymous users, disallowing remote root login, and removing the test database.

```bash
sudo apt install mysql-server-5.7
sudo mysql_secure_installation
```

--------------------------------

### Configure PHP 8.2 Timezone

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Sets the timezone for PHP 8.2 by editing the `php.ini` file. This ensures that date and time functions in PHP applications correctly reflect the server's or application's intended timezone. The example sets the timezone to "Europe/London".

```ini
; Example line in /etc/php/8.2/apache2/php.ini
date.timezone = "Europe/London"
```

--------------------------------

### List Passwords (First Page) - PHP Example

Source: https://teampasswordmanager.com/docs/api-v2

This PHP script demonstrates how to fetch the first page of passwords using cURL. It includes setting up the base URL, request URI, authentication credentials, headers, and handling the response.

```php
<?php	
  // Parameters
  $tpm_base_url = 'https://tpm.mydomain.com/index.php/'; // ending with /
  $req_uri = 'api/v2/passwords.json'; // GET /passwords.json
  $username = 'YOUR USERNAME';
  $password = 'YOUR PASSWORD';

  // Request headers
  $headers = array(	
    'Content-Type: application/json; charset=utf-8'
  );
	
  // Request
  $ch = curl_init($tpm_base_url . $req_uri);
  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
  curl_setopt($ch, CURLOPT_HEADER, TRUE); // Includes the header in the output
  curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password);
  $result = curl_exec($ch);	
  $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);	
  curl_close($ch);

  // Get headers and body
  list($headers, $body) = explode("\r\n\r\n", $result, 2);
  $arr_headers = explode("\r\n", $headers);
  $arr_body = json_decode($body, TRUE);

  // Show status and array of passwords
  echo 'Status: ' . $status . '<br/>';
  print_r($arr_body);
?>
```

--------------------------------

### Install and Configure Fail2ban on Ubuntu

Source: https://teampasswordmanager.com/docs/install-ubuntu-18

Installs Fail2ban, a service that protects the server from brute-force attacks by monitoring log files and banning suspicious IP addresses. It also includes basic configuration setup.

```bash
$ sudo apt install fail2ban
$ sudo cp /etc/fail2ban/fail2ban.conf /etc/fail2ban/fail2ban.local

```

--------------------------------

### Example SHA256 Checksum Verification (macOS)

Source: https://teampasswordmanager.com/docs/md5-checksum

An example showing the verification of a SHA256 checksum for a downloaded file on macOS. This example clarifies the command syntax and the structure of the output, aiding in file integrity confirmation.

```bash
$ shasum -a 256 teampasswordmanager_12.152.275.zip 
5a57bcc73bda953433135c4348a63815e2acac8c9ce1d87a70ad0c73238dd4a2  teampasswordmanager_12.152.275.zip
```

--------------------------------

### Create MySQL Database and User for Team Password Manager

Source: https://teampasswordmanager.com/docs/install-ubuntu-20

This section details the SQL commands required to set up a MySQL database and a dedicated user for Team Password Manager. It includes creating the database with specific character set and collation, creating a user with a password, and granting all necessary privileges to that user on the created database. It also highlights the use of `mysql_native_password` due to PHP compatibility.

```sql
$ sudo mysql
mysql> CREATE DATABASE `tpm_database` CHARACTER SET utf8 COLLATE utf8_unicode_ci;
mysql> CREATE USER 'tpm_user'@'%' IDENTIFIED WITH mysql_native_password BY 'tpmPass%2022';
mysql> GRANT ALL ON tpm_database.* TO 'tpm_user'@'%';
mysql> FLUSH PRIVILEGES;
```

--------------------------------

### Install PHP 8.2 and Required Modules on Ubuntu

Source: https://teampasswordmanager.com/docs/install-ubuntu-22

Installs PHP 8.2 and essential modules for Team Password Manager on Ubuntu 22.04. This involves adding a PPA for newer PHP versions, updating package lists, and then installing the specific PHP version and modules like cli, mysql, mbstring, ldap, curl, gd, and xml.

```bash
sudo add-apt-repository ppa:ondrej/php
sudo apt update
sudo apt install php8.2 php8.2-cli php8.2-mysql php8.2-mbstring php8.2-ldap php8.2-curl php8.2-gd php8.2-xml
```

--------------------------------

### Example MD5 Checksum Verification (macOS)

Source: https://teampasswordmanager.com/docs/md5-checksum

An example demonstrating how to check the MD5 checksum of a specific downloaded file on macOS. This illustrates the command usage and expected output format for verification.

```bash
$ md5 teampasswordmanager_10.135.236.zip
MD5 (teampasswordmanager_12.152.275.zip) = 2b22da4d3075f1f337d3bcfe292e1b65
```

--------------------------------

### PHP Example for Searching Projects API v4

Source: https://teampasswordmanager.com/docs/api-v4-projects

An example demonstrating how to construct a search URL for projects using PHP, including URL encoding the search string. This is necessary for the `/projects/search/urlencoded_string.json` endpoint.

```PHP
$search_string = 'website'; // Find projects that contain "website"
$search_string_urlencoded = urlencode($search_string);
$request_url = 'https://YOUR_TPM_URL/index.php/api/v4/projects/search/' . $search_string_urlencoded . '.json';
```

--------------------------------

### Bash Script for Team Password Manager Provisioning

Source: https://teampasswordmanager.com/docs/install-vagrant-virtualbox

The provision.sh script installs and configures all required software for Team Password Manager, including the web server, database, PHP, and Team Password Manager itself. This script is executed by Vagrant upon running 'vagrant up'.

```bash
# This script is called by Vagrantfile when the `vagrant up` command is executed.
# It installs and configures the software required to run Team Password Manager
# and also Team Password Manager itself.
```

--------------------------------

### Show a Specific Password (PHP & cURL)

Source: https://teampasswordmanager.com/docs/api-v5

This snippet shows how to retrieve all data for a specific password using its internal ID. It involves making a GET request to the '/passwords/{id}.json' endpoint. The PHP example modifies the `$req_uri` from the previous example, while the cURL example directly specifies the password ID in the URL.

```php
$req_uri = 'api/v5/passwords/1.json'; // GET /passwords/1.json
```

```curl
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v5/passwords/1.json
```

--------------------------------

### Display PHP Configuration with phpinfo()

Source: https://teampasswordmanager.com/docs/phpinfo

This snippet demonstrates how to create a simple PHP file that utilizes the built-in phpinfo() function to display detailed information about the current PHP environment. This is useful for verifying PHP version, installed modules, and configuration settings.

```php
<?php
phpinfo();
?>
```

--------------------------------

### Project List Example Response (JSON)

Source: https://teampasswordmanager.com/docs/api-projects

This is an example of a successful JSON response when listing projects. It includes detailed information for each project such as ID, name, full path, tags, archive status, favorite status, file count, manager details, creator, and update timestamps.

```JSON
[
    {
        "id": 5,
        "name": "Company projects",
        "full_path": [
            {
                "id": 6,
                "name": "Internal",
                "archived": false
            },
            {
                "id": 5,
                "name": "Company projects",
                "archived": false
            }
        ],
        "tags": "project",
        "archived": false,
        "favorite": false,
        "num_files": 0,
        "managed_by": {
            "id": 1,
            "username": "john",
            "email_address": "john@teampasswordmanager.com",
            "name": "John Boss",
            "role": "Admin"
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-16 19:00:24"
    },
    {
        "id": 18,
        "name": "www.fictionalgadgetsite.com",
        "full_path": [
            {
                "id": 6,
                "name": "Internal",
                "archived": false
            },
            {
                "id": 5,
                "name": "Company projects",
                "archived": false
            },
            {
                "id": 18,
                "name": "www.fictionalgadgetsite.com",
                "archived": false
            }
        ],
        "tags": "client",
        "archived": false,
        "favorite": false,
        "num_files": 0,
        "managed_by": {
            "id": 3,
            "username": "claire",
            "email_address": "claire@teampasswordmanager.com",
            "name": "Claire Wood",
            "role": "Project manager"
        },
        "created_by": {
            "id": 1
        },
        "created_on": "2024-12-16 14:36:08",
        "updated_by": {
            "id": 1
        },
        "updated_on": "2024-12-16 14:36:08"
    },
    ...
]
```

--------------------------------

### GET /passwords.json

Source: https://teampasswordmanager.com/docs/api-v1-authentication

Example of retrieving a list of passwords using HTTP Basic Authentication.

```APIDOC
## GET /passwords.json

### Description
Retrieves a list of passwords accessible to the authenticated user. This example demonstrates usage with HTTP Basic Authentication.

### Method
GET

### Endpoint
`/api/v1/passwords.json`

### Parameters
None for this endpoint.

### Request Example
#### curl
```bash
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v1/passwords.json
```

#### PHP
```php
<?php
  // Parameters
  $tpm_base_url = 'https://tpm.mydomain.com/index.php/'; // ending with /
  $req_uri = 'api/v1/passwords.json'; // GET /passwords.json
  $username = 'YOUR USERNAME';
  $password = 'YOUR PASSWORD';

  // Request headers
  $headers = array(
    'Content-Type: application/json; charset=utf-8'
  );

  // Request
  $ch = curl_init($tpm_base_url . $req_uri);
  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
  curl_setopt($ch, CURLOPT_HEADER, TRUE); // Includes the header in the output
  curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password); // HTTP Basic Authentication
  $result = curl_exec($ch);
  $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
  curl_close($ch);

  // Get headers and body
  list($headers, $body) = explode("\r\n\r\n", $result, 2);
  $arr_headers = explode("\r\n", $headers);
  $arr_body = json_decode($body, TRUE);

  // Show status and array of passwords
  echo 'Status: ' . $status . '<br/>';
  print_r($arr_body);
?>
```

### Response
#### Success Response (200)
- **Array of passwords** (array) - Contains password entries.

#### Response Example
```json
{
  "passwords": [
    {
      "id": 1,
      "name": "Example Password",
      "description": "This is an example password entry.",
      "url": "http://example.com"
    }
  ]
}
```
```

--------------------------------

### Get Groups List

Source: https://teampasswordmanager.com/docs/api-v2-passwords

Retrieves a list of groups within the Team Password Manager installation.

```http
GET /groups.json
```

--------------------------------

### Get Users List

Source: https://teampasswordmanager.com/docs/api-v2-passwords

Retrieves a list of users within the Team Password Manager installation.

```http
GET /users.json
```

--------------------------------

### Verifying Directory Structure and Permissions

Source: https://teampasswordmanager.com/docs/install-ubuntu

This command lists the contents of the Team Password Manager installation directory with detailed information, including ownership, permissions, and timestamps. This is used to verify that the directory creation, ownership, and permission settings were applied correctly.

```bash
myuser@myhostname:/var/www/html/tpm.mycompany.com$ ls -la
total 16
drwxr-xr-x 4 www-data www-data 4096 Mar 11 12:42 .
drwxr-xr-x 3 root     root     4096 Mar 11 12:42 ..
drwxr-s--- 2 www-data www-data 4096 Mar 11 12:49 logs
drwxrws--- 7 www-data www-data 4096 Mar 11 19:29 public_html
```

--------------------------------

### Create Project using cURL and PHP

Source: https://teampasswordmanager.com/docs/api-v3

Demonstrates how to create a new project in Teampasswordmanager via the API. It requires authentication credentials and project name. The response includes the status code and details of the created project.

```curl
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{"name":"My new project"}' \
  -i https://tpm.mydomain.com/index.php/api/v3/projects.json
```

```php
<?php	
  // Parameters
  $tpm_base_url = 'https://tpm.mydomain.com/index.php/'; // ending with /
  $req_uri = 'api/v3/projects.json'; // POST /projects.json
  $username = 'YOUR USERNAME';
  $password = 'YOUR PASSWORD';

  // Request headers
  $headers = array(	
    'Content-Type: application/json; charset=utf-8'
  );

  // Body (json encoded array)
  $request_body = json_encode(array(
    'name' => 'This is a new project'
  ));

  // Request
  $ch = curl_init($tpm_base_url . $req_uri);
  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
  curl_setopt($ch, CURLOPT_HEADER, TRUE); // Includes the header in the output
  curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . $password);
  curl_setopt($ch, CURLOPT_POST, TRUE);
  curl_setopt($ch, CURLOPT_POSTFIELDS, $request_body);
  $result = curl_exec($ch);	
  $status = curl_getinfo($ch, CURLINFO_HTTP_CODE);	
  curl_close($ch);

  // Get headers and body
  list($headers, $body) = explode("\r\n\r\n", $result, 2);
  $arr_headers = explode("\r\n", $headers);
  $arr_body = json_decode($body, TRUE);

  // Show status and the new project id
  echo 'Status: ' . $status . '<br/>';
  print_r($arr_body);
?>
```

--------------------------------

### Verifying Directory Structure and Permissions

Source: https://teampasswordmanager.com/docs/install-ubuntu-18

This command lists the contents of the Team Password Manager installation directory in a long format, showing details about ownership, permissions, and modification times. It's used to verify that the `public_html` and `logs` directories have been created correctly and that the ownership and permissions for `public_html` are set as intended.

```bash
myuser@myhostname:/var/www/html/tpm.mycompany.com$ ls -la
total 16
drwxr-xr-x 4 root   root   4096 Mar 28 18:28 .
drwxr-xr-x 3 root   root   4096 Mar 28 18:28 ..
drwxr-xr-x 2 root   root   4096 Mar 28 18:28 logs
drwxr-xr-x 2 myuser myuser 4096 Mar 28 18:28 public_html
```

--------------------------------

### Making a GET Request to Fetch Passwords

Source: https://teampasswordmanager.com/docs/api

This example demonstrates how to use `curl` to make a GET request to the Team Password Manager API to fetch a list of passwords using HTTP Basic Authentication. It includes the necessary headers and URL structure.

```APIDOC
## GET /api/v6/passwords.json

### Description
Fetches a list of passwords for the authenticated user.

### Method
GET

### Endpoint
`YOUR_TEAM_PASSWORD_MANAGER_URL/index.php/api/v6/passwords.json`

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -u username:password \
  -H 'Content-Type: application/json; charset=utf-8' \
  -i https://tpm.mydomain.com/index.php/api/v6/passwords.json
```

### Response
#### Success Response (200)
- **Array of Password Objects**: Contains password details.

#### Response Example
```json
{
  "example": "[Your password objects here]"
}
```
```
Tokens:
Raw