Переменные окружения основы командной строки

Зарегистрируйтесь для доступа к 15+ бесплатным курсам по программированию с тренажером

xterm-256color
/bin/bash
en_US.UTF-8
kirill.m
v2711
/home/kirill.m/bin:/home/kirill.m/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
/home/kirill.m
en_US.UTF-8
1
/home/kirill.m
kirill.m

# а перед самой переменной ставится знак $
 

/home/kirill.m

# Вокруг знака `=` не должно быть пробелов
/tmp
 

/tmp

# Возвращаем обратно
/home/kirill.m
 

/home/kirill.m

# Достаточно выполнить присваивание слева от запускаемой команды
/tmp 

/tmp



/tmp

/home/kirill.m

 

/home/kirill.m

 

/home/kirill.m

/tmp


/tmp

 

/tmp

Открыть доступ

Курсы программирования для новичков и опытных разработчиков. Начните обучение бесплатно

• 130 курсов, 2000+ часов теории

• 1000 практических заданий в браузере

• 360 000 студентов

Наши выпускники работают в компаниях:

В современных ОС компании Microsoft на платформе NT для получения информации о системе используются следующие переменные (Полужирным выделен текст, относящийся только к Windows Vista/7):

Работа с переменными

Чтобы получить доступ к значению переменной, необходимо поставить знак % перед её названием и после него, например:

echo %PROCESSOR_ARCHITECTURE%

Чтобы установить значение переменной:

SET TEMP=C:\TEMP

Также необходимо помнить, что, в отличие от UNIX-систем, в DOS и в стандартной командной строке Windows переменные среды не наследуются запускаемыми процессами, а используются совместно. Это позволяет, например, возвращать через них результаты работы программ, но, с другой стороны, создаёт возможность порчи или переполнения. Особенно актуально переполнение для переменной PATH, поскольку она часто дополняется при работе различных скриптов. При возникновении такого переполнения достаточно просто перезапустить интерпретатор командной строки. Интерпретаторы, портированные из UNIX-систем (например, Z-shell), такой проблеме не подвержены.

Получить значение переменной в программном коде можно с помощью метода ExpandEnvironmentStrings COM-объекта WScript.Shell:

WScriptShell = ObjCreate("WScript.Shell")
UserName = WScriptShell.ExpandEnvironmentStrings("%USERNAME%")

Следует учитывать, что набор значений переменных среды получается процессом во время его запуска, все запускаемые им подчиненные процессы получают значения переменных из этого набора, если второй процесс (независимый от первого) изменяет значение переменной среды или создает новую переменную, эти изменения не будут доступны первому процессу.

Что вас ожидает в этом руководстве

Безопасное управление конфиденциальными данными и настройками приложений может показаться сложной задачей для начинающих разработчиков. В этой статье мы разберем важные аспекты работы с переменными окружения, которые сделают вашу разработку более безопасной и эффективной.

Важно отметить, что рассмотренное решение не является лучшим способом для хранения секретных данных, однако, важность понимания принципов работы с переменными окружения сложно переоценить.

Что такое переменные окружения?

Переменные окружения — это значения, которые используются в различных командах и программных сценариях, выполняемых в операционной системе. Принципиально они работают точно так же, как переменные в языках программирования. Они представляют знакомые нам пары «ключ-значение» и используются для хранения параметров, настроек приложений, хранения ключей и других информационных данных.

Первый взгляд и практика

Давайте узнаем, какие переменные окружения уже есть в вашей операционной системе.

Примеры команд представлены для командной строки Windows и оболочки Unix (подобных) операционных систем отдельно.

set

printenv

Таким образом, вы увидите список переменных, которые уже существуют в окружении.

Взгляните внимательно на переменную окружения с именем PATH. Она имеет очень большое значение и содержит пути к директориям, содержащим исполняемые файлы программ. Когда мы обращаемся к различному программному обеспечению, используя его имя:

Исполняемый файл с именем node (или node.exe для Windows) должен находиться в директориях, перечисленных в переменной окружения PATH. Если найти его не удастся, вы получите сообщение об ошибке:

command not found: node

"node" is not recognized as an internal or external command, operable program or batch file.

Если node.js уже установлен в операционной системе, но вы хотите ознакомиться с сообщением об ошибке из примера, используйте вместо node другой набор символов, который не будет соответствовать ни одному исполняемому файлу в директориях, перечисленных в PATH. Например, foo, bar или вовсе abracadabra123.

Если у вас уже установлена требуемая программа, но ее расположение отсутствует в переменной PATH, можно использовать полный путь к файлу в команде:

"C:\Program Files\nodejs\node.exe" main.js

# пример для nvm
/root/.nvm/versions/node/v16.18.0/bin/node main.js 

Напротив, если программа установлена и место ее расположения присутствует в переменной PATH, вы сможете узнать ее точное расположение следующим образом:

where node

which node

Создание, использование и удаление переменных окружения

Попробуем создать новую переменную:

# Переменная доступна только для текущего сеанса командной строки
set MSG=hello

# Необходим перезапуск сессии командной строки
# Такая переменная останется доступной даже после перезапуска операционной системы 
setx MSG hello /M /D

# Переменная доступна только для текущего сеанса терминала:
MSG=hello

# Необходим перезапуск сессии терминала,
# но переменная доступна для всех дочерних процессов 
export MSG=hello

# Чтобы сделать переменную доступной после перезагрузки операционной системы,
# необходимо добавить ее объявление в соответствующий файл конфигурации вашей оболочки
# .bashrc для Bash
echo 'export MSG=hello' >> ~/.bashrc
source ~/.bashrc

# .zshrc для Zsh
echo 'export MSG=hello' >> ~/.zshrc
source ~/.zshrc

Обратите внимание: так как переменные окружения являются константами, то общепринято писать их названия в верхнем регистре.

Пробуем использовать новую переменную:

echo %MSG%

echo $MSG

Теперь удаляем переменную:

set MSG=
setx MSG ''

unset MSG
# Также не забывайте удалить объявление переменной из файла
# конфигурации оболочки, если она была объявлена в нем. В противном
# случае, после перезапуска операционной системы переменная снова
# будет создана

Конфиденциальные данные в приложении

Наше программное обеспечение использует различного рода конфиденциальную информацию для полноценной работы. Такой информацией может оказаться API/SSH ключ, пароль для подключения к базе данных, ssl-сертификат или нечто похожее. Если мы расположим эти данные внутри нашего публичного хранилища исходного кода, произойдет их компрометация. Даже в случае, если хранилище приватное, расположение секретной информации означает, что все его коллабораторы или пользователи получают доступ к закрытой информации.

Однако мы можем избежать таких рисков, переместив секретную информацию за пределы хранилища и заменив ее ссылками на место, где она безопасно хранится. Такой подход обеспечивает высокий уровень безопасности, поскольку каждый пользователь будет иметь доступ только к собственному месту хранения конфиденциальных данных. Например, каждый пользователь может иметь свой пароль к локальной базе данных, и его ссылка будет указывать именно на личное хранилище с этим паролем.

Использование внешних хранилищ для секретных данных позволяет нам эффективно управлять доступом к этой информации и предотвратить несанкционированный доступ. Кроме того, это делает сотрудничество в команде более безопасным. Этот подход также облегчает ротацию ключей и паролей без необходимости изменения кода приложения, что повышает уровень защиты и снижает риски для безопасности данных.

Хранение секретных данных в переменных окружения

Рассмотрим в качестве хранилища секретных данных переменные окружения.

Давайте представим, что нашему приложению необходимо подключение к базе данных. В этом случае мы создадим несколько переменных среды, разместив в них необходимую информацию на сервере:

echo 'export DB_HOST=srv_db_host' >> ~/.bashrc
echo 'export DB_PORT=srv_db_port' >> ~/.bashrc
echo 'export DB_NAME=srv_db_name' >> ~/.bashrc
echo 'export DB_USER=srv_db_user' >> ~/.bashrc
echo 'export DB_PASSWORD=srv_db_password' >> ~/.bashrc

source ~/.bashrc

Рабочее место разработчика

echo 'export DB_HOST=local_db_host' >> ~/.bashrc
echo 'export DB_PORT=local_db_port' >> ~/.bashrc
echo 'export DB_NAME=local_db_name' >> ~/.bashrc
echo 'export DB_USER=local_db_user' >> ~/.bashrc
echo 'export DB_PASSWORD=local_db_password' >> ~/.bashrc

source ~/.bashrc

Внимание! Располагать переменные окружения в файле bashrc без ограничения доступа к нему посторонним лицам неприемлемо, информация предоставлена только в демонстративных целях!

Теперь мы можем получить доступ к этим переменным внутри приложения:

/*
process.env является глобальной переменной внутри node.jsприложения.
Она хранит в себе состояние всех переменных окружения ОС
на момент запуска приложения.
*/

const dbHost = process.env.DB_HOST;
const dbPort = process.env.DB_PORT;
const dbName = process.env.DB_NAME;
const dbUser = process.env.DB_USER;
const dbPassword = process.env.DB_PASSWORD;

'''
В языке программирования python доступ к переменным окружения
возможно получить с использованием модуля OS. 
'''

import os

db_host = os.environ['DB_HOST']
db_port = os.environ['DB_PORT']
db_name = os.environ['DB_NAME']
db_user = os.environ['DB_USER']
db_password = os.environ['DB_PASSWORD']

/* 
в языке программирования Go доступ к переменным окружения осуществляется
c помощью пакета OS.
*/

package main

import (
	"os"
)

func main() {
	dbHost := os.Getenv("DB_HOST")
	dbPort := os.Getenv("DB_PORT")
	dbName := os.Getenv("DB_NAME")
	dbUser := os.Getenv("DB_USER")
	dbPassword := os.Getenv("DB_PASSWORD")
}

Использование файла .env для хранения переменных

Ранее мы рассмотрели, каким образом конфиденциальная информация может напрямую сохраняться в окружении операционной системы. Такой способ имеет некоторые недостатки. Эти переменные доступны не только для приложения.

Также есть некоторое неудобство их администрирования: они смешаны с переменными окружения, которые не нужны нашему приложению. Процесс замены значений переменных, в свою очередь, тоже не очень удобен.

Можем ли мы отделить необходимые переменные от остальных, сделать доступными только для приложения и управлять их состоянием удобным способом?
Да, мы можем воспользоваться практикой, ставшей золотым стандартом для решения этих проблем. Она заключается в использовании специальных библиотек, позволяющих при запуске приложения в его область видимости добавить ряд переменных, которые останутся недоступны другим процессам в операционной системе. Такие библиотеки присутствуют во всех популярных стеках разработки и используют в качестве хранилища специальный файл, оформленных строго определенным образом. Имя этого файла — .env (от англ. «environment»).

Синтаксис файла .env

Файл .env — это обычный текстовый файл без расширения с именем .env, каждая строка которого представляет собой пару ключ=значение. Вот пример записей переменных в такой файл:

DB_HOST=local_db_host
DB_PORT=local_db_port
DB_NAME=local_db_name
DB_USER=local_db_user
DB_PASSWORD=local_db_password

Давайте подключим этот файл в наше приложение, используя библиотеки, соответствующие необходимому стеку разработки:

/*
Установим библиотеку dotenv при помощи пакетного менеджера:
npm install dotenv
или
yarn add dotenv
*/

const dotenv = require('dotenv');
dotenv.config();

const dbHost = process.env.DB_HOST;
const dbPort = process.env.DB_PORT;
const dbName = process.env.DB_NAME;
const dbUser = process.env.DB_USER;
const dbPassword = process.env.DB_PASSWORD;

/* 
Объявленные переменные содержат соответствующие значения из .env файла.
Node.js версии 20 предоставляет экспериментальную поддержку .env файлов
без использования библиотеки "dotenv":
node --env-file=.env app.js
*/

# Установим пакет python-dotenv с помощью pip
# pip install python-dotenv

import os
from dotenv import load_dotenv

load_dotenv()

db_host = os.getenv("DB_HOST")
db_port = os.getenv("DB_PORT")
db_name = os.getenv("DB_NAME")
db_user = os.getenv("DB_USER")
db_password = os.getenv("DB_PASSWORD")

# Объявленные переменные содержат значения из .env файла и могут быть использованы

/*
Установим пакет github.com/joho/godotenv с помощью go get
go get github.com/joho/godotenv
*/

package main

import (
	"github.com/joho/godotenv"
	"os"
)

func main() {
	err := godotenv.Load()

    if err != nil {
        log.Fatalf("Error loading .env file")
    }

	dbHost := os.Getenv("DB_HOST")
	dbPort := os.Getenv("DB_PORT")
	dbName := os.Getenv("DB_NAME")
	dbUser := os.Getenv("DB_USER")
	dbPassword := os.Getenv("DB_PASSWORD")

    // Объявленные переменные содержат значения из .env файла и могут быть использованы
}

ВНИМАНИЕ! Одна из важнейших целей использования .env в проекте — это отсутствие конфиденциальных данных в репозитории. Не забывайте позаботиться о добавлении .env в .gitignore, если вы используете git как систему контроля версий. Если используете альтернативную систему контроля версий, исключите .env в соответствии с технической документацией.

Разместите в .gitignore:

# Excluding the 
.env file.env

Такой подход хранения конфиденциальной информации можно наблюдать в большинстве крупных фреймворков или библиотек.

• Laravel — один из наиболее популярных фреймворков для разработки веб-приложений на PHP. Файл .env в Laravel используется для хранения настроек базы данных, настроек приложения, секретных ключей, параметров электронной почты и других конфигурационных параметров. Laravel автоматически загружает переменные окружения из файла .env при запуске приложения.

• Django — это фреймворк для разработки веб-приложений на Python. В проектах Django также распространено использование файла .env для хранения настроек базы данных, секретных ключей, настроек электронной почты и других конфигурационных параметров. Для загрузки переменных окружения из файла .env в Django обычно используется библиотека python-dotenv.

• Ruby on Rails — фреймворк для разработки веб-приложений на Ruby. В проектах Ruby on Rails также популярно использование файла .env для хранения конфигурационных параметров, включая параметры базы данных, ключи API и другие настройки. Для загрузки переменных окружения из файла .env в Ruby on Rails обычно используется библиотека dotenv-rails.

На практике многие разработчики используют файл .env в своих проектах, чтобы легко настраивать и хранить параметры окружения и секретные данные без необходимости отображения их в коде.

.env.example

Правилами хорошего тона считается создание файла с именем .env.example, который должен хранить список необходимых для заполнения переменных. Этот файл используется для документирования и предоставления возможного примера заполнения значений переменных окружения. Обратите внимание, он может находиться в репозитории, но при этом не должен содержать настоящей конфиденциальной информации.

Заключение

В данной статье были рассмотрены важные аспекты обработки конфиденциальной информации в приложениях. Мы познакомились с наиболее распространенным способом сокрытия конфиденциальной информации из репозиториев программного обеспечения.

Давайте помнить, что безопасное обращение с конфиденциальными данными — это важный аспект разработки программного обеспечения. Использование файла .env в сочетании с грамотно организованными переменными окружения помогает обеспечить защиту информации и упрощает настройку приложений для различных окружений.

Спасибо за внимание!

Язык программирования Go

Go (или Golang) – это язык программирования, разработанный компанией Google, который объединяет высокую производительность и простоту разработки. Основной целью создания Go было получить надежный и эффективный язык программирования для написания масштабируемого и параллельного программного обеспечения.

Что такое GOPATH

GOPATH – это переменная среды в языке программирования Go, которая указывает на корневой каталог вашего рабочего пространства (workspace). Переменная GOPATH означает путь к директории, которая содержит ваши проекты Go, исходные коды, сторонние библиотеки и другие файлы, связанные с разработкой на Go. Когда компилятор Go ищет пакеты и зависимости, он обращается к GOPATH для определения местоположения файлов. GOPATH является одной из наиболее важных переменных среды для разработки на Go.

Главная роль переменной GOPATH в Go заключается в том, чтобы указать компилятору, где искать и хранить исходные файлы и библиотеки, которые вы используете в своих проектах.

При работе с GOPATH, вам необходимо организовать свои пакеты в соответствии с их импортными путями. Например, если ваш проект называется myproject, ваш исходный файл должен находиться в $GOPATH/src/myproject/main.go.

Что такое GOROOT

Переменная GOROOT в языке программирования Go указывает на корневую директорию установки компилятора Go. Переменная GOROOT означает местоположение, где находятся исполняемые файлы компилятора Go и стандартная библиотека языка.

GOROOT используется компилятором Go для поиска и загрузки стандартных пакетов и инструментов, необходимых для разработки на языке Go. При установке языка программирования, GOROOT автоматически загружается на директорию, где был установлен компилятор.

Важно отличать переменную GOROOT от переменной GOPATH. GOROOT указывает на местоположение компилятора и стандартной библиотеки, в то время как GOPATH определяет местоположение вашего проекта Go и сторонних библиотек.

Переменная GOROOT устанавливается автоматически при установке Go и обычно остается неизменной на протяжении работы с языком. 

Использование переменной GOROOT помогает обеспечить правильную компиляцию и выполнение программ на Go, а также обеспечивает доступ к стандартным пакетам и инструментам языка.

Что такое PATH

Переменная PATH – это системная переменная окружения в операционной системе, которая определяет пути поиска для исполняемых файлов. Когда вы вводите команду в командной строке или запускаете программу, операционная система ищет исполняемый файл в папках, указанных в переменной PATH.

По умолчанию PATH содержит несколько папок. Если вы запустите команду без указания полного пути к исполняемому файлу, операционная система автоматически будет искать этот файл в каждой папке, указанной в PATH.

Вы можете изменить переменную PATH, добавив новые пути поиска или изменив порядок существующих папок. Это может быть полезно, например, если вы хотите добавить путь к папке с вашими собственными скриптами или утилитами, для возможности запуска команд из этих папок в любом месте в командной строке.

Чтобы просмотреть текущее значение переменной PATH в командной строке Windows, вы можете ввести команду:

Чтобы изменить переменную PATH временно в текущем сеансе командной строки, вы можете использовать команду set:

Если вы хотите изменить переменную PATH постоянно, то вам нужно будет изменить настройки системы. Для этого откройте раздел Параметры системы > Дополнительные параметры системы > Переменные среды. Выберите переменную PATH в пункте Системные переменные и нажмите Изменить, чтобы добавить или изменить пути поиска.

Изменяя переменную PATH будьте осторожны: если вы удалите или измените существующие пути поиска, это повлечет ошибки в работе операционной системы и других установленных программ.

Для проектов любой сложности, разрабатываемых на операционной системе Windows, предлагаем воспользоваться услугой Windows VDS/VPS от RU-CENTER.

Команда go install

Команда go install – это команда инструмента управления пакетами Go (Go Package Manager), которая компилирует и устанавливает пакеты Go в указанное окружение или директорию.

Когда вы используете команду go install, она просматривает файлы и зависимости вашего проекта Go и компилирует их в исполняемые файлы или библиотеки. Затем она копирует эти исполняемые файлы или библиотеки в директорию bin переменной GOPATH (каталог $GOPATH/bin).

Команда go install полезна в следующих случаях:

1. Для установки пакетов в вашу систему, что позволит им быть доступными в любом месте. Когда вы устанавливаете пакет с помощью go install, это позволяет вам запускать исполняемые файлы, связанные с этим пакетом, из любой директории в командной строке.
2. Для компиляции и установки библиотек или модулей Go в ваш GOPATH, чтобы они были доступны для импорта и использования в других проектах Go. Когда вы устанавливаете библиотеку с помощью go install, она помещается в директорию pkg внутри вашего GOPATH, где ее можно импортировать в другие проекты.

Для использования команды go install вам может понадобиться правильно настроенные переменные среды GOPATH и GOBIN, чтобы указать путь к директории, где будут установлены пакеты или библиотеки Go.

Команда go install широко используется при разработке проектов на Go для установки и управления пакетами, а также для возможности делиться кодом и библиотеками с другими разработчиками.

Рабочее пространство платформы Go

Рабочее пространство (Workspace) в платформе Go представляет собой организационную структуру директорий, которая используется для разработки проектов на Go. Это набор каталогов, в которых хранятся исходные коды проектов, сторонние зависимости и другие файлы связанные с разработкой.

Структура рабочего пространства Go основана на переменной среды GOPATH,  обычно она включает в себя следующие каталоги:

1. Каталог src (source) содержит исходные файлы всех пакетов Go, включая ваши собственные пакеты. Внутри каталога src обычно находятся каталоги, соответствующие импортным путям пакетов, например, github.com/username/project.
2. Каталог pkg (package) используется для хранения скомпилированных объектных файлов пакетов. Когда компилятор Go создает объектные файлы, они сохраняются в этом каталоге.
3. Каталог bin (binary) используется для хранения бинарных (исполняемых) файлов, созданных при компиляции проекта. Эти файлы могут быть запущены как исполняемые команды в командной строке.

Кроме того, в рабочем пространстве могут находиться также другие директории, связанные с задачами разработки, такие как документация, тесты и т.д.

По умолчанию GOPATH установлен на $HOME/go для большинства систем, но вы можете изменить его на свой усмотрение. Рекомендуется иметь отдельное рабочее пространство для каждого проекта, чтобы изолировать код проектов друг от друга.

Использование правильной структуры рабочего пространства Go позволяет упорядочить различные аспекты разработки и обеспечивает легкость сопровождения и масштабирования проекта. Вцелом рабочее пространство позволяет вести структурированную организацию проектов на Go, помогая управлять и разрабатывать приложения более эффективно.

Похожее:

Переменные окружения в Linux – ИТ Проффи Переменные среды windows server Переменные среды Windows 11 и Windows 10 — где находятся, как создать и настроить Переменные окружения Windows 10 и Windows 11