Introduction

Since version 6 of the Freebox, there is a web interface (https://mafreebox.freebox.fr) that allows you to control several options, including rebooting it. We will use this capability to restart it via the command line. For this purpose, I’m using a script that was obtained from admin-linux.fr.

I tested it on Debian and it works natively. On pfSense 2.0.1, I encountered a few small issues. That’s why I will detail here how I resolved them.

Installation

Prerequisites

You’ll need bash and wget to run the script that follows. On most distributions, there are no issues as they are already installed. But on minimal or embedded versions, this can cause problems. I will explain how to proceed on pfSense.

pkg_add

Install wget and bash:

1
2

pkg_add -vr wget
pkg_add -vr bash

Manually

If you encounter problems because the repository no longer exists, take the one closest to your version and upload the files to your machine (pfSense for example):

1
2

wget ftp://ftp.freebsd.org/pub/FreeBSD/ports/i386/packages-8.2-release/ftp/wget-1.12_2.tbz
wget ftp://ftp.beastie.tdk.net/pub/FreeBSD/ports/i386/packages-8.2-release/shells/bash-4.1.9.tbz

Then we’ll decompress everything:

1
2
3

cd /
tar -xzf wget-1.12_2.tbz
tar -xzf bash-4.1.9.tbz

Script

Let’s put this script in /bin/freebox for example:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

#!/bin/bash

# Description : Script for rebooting the FreeBox
#	from the command line.
# Author : FHH <fhh@admin-linux.fr>
# $Id: freebox,v 1.6 2011/08/28 22:59:56 fhh Exp $

# Global script variables:
USERNAME="freebox" ;
URL="http://mafreebox.freebox.fr" ;

WORKING_DIRECTORY="${HOME}/.freebox" ;
CONFIG_FILE="${WORKING_DIRECTORY}/config" ;
TMP_DIRECTORY="${WORKING_DIRECTORY}/tmp" ;
COOKIES="cookies" ;

FREE_LOGIN_SCRIPT="/login.php" ;
FREE_REBOOT_CGI="/system.cgi" ;
WGET_OPTS="-T1 -t1 -qO /dev/null" ;

# usage : Display help
usage () {
	echo -e "$0 <options> [command]\n" ;
	echo "Options" ;
	echo " -h		: Display this help message." ;
	echo " -p <pass>	: Specify the FreeBox password." ;
	echo ;
	echo "Commands" ;
	echo " restart	: Restart the freebox." ;
	echo " savepass	: Save the password." ;
	echo ;
	echo "In case of malfunction, check your " ;
	echo "FreeBox password and/or the file \"~/.freebox/config\"." ;
}

# Script exit function:
die() {
        echo $@ >&2 ;
        exit 1 ;
}
# Authentication function on the FreeBox
auth() {
#       Authentication and cookie registration:
	wget ${WGET_OPTS} --save-cookies "${TMP_DIRECTORY}/${COOKIES}" --post-data "login=${USERNAME}&passwd=${password}" "${URL}/${FREE_LOGIN_SCRIPT}" ;
#	If the cookie is not downloaded, authentication failed:
	[ -e "${TMP_DIRECTORY}/${COOKIES}" ] || die "> Authentication failure. Check the password." ;
	[ ! -z "$(sed -e 's/[[:blank:]]//g' -e '/^#\|^$/d' "${TMP_DIRECTORY}/${COOKIES}")" ] || die "> Authentication failed. Check the password." ;
}

# Password input function
askpwd() {
	cpt=0 ;
	while [ -z "${password}" ] ; do
		(( ${cpt} >= 3 )) && die "> You must provide your password. Stop!" ;
		(( cpt = cpt + 1 )) ; 
		read -sp "Password: " password ;
		echo ;
	done
}

init () {
	[ ! -d "${WORKING_DIRECTORY}" ] && { mkdir "${WORKING_DIRECTORY}" || die "> Unable to create \"${WORKING_DIRECTORY}\"" ; }
	[ ! -d "${TMP_DIRECTORY}" ] && { mkdir "${TMP_DIRECTORY}" || die "> Unable to create \"${TMP_DIRECTORY}\"" ; }
	[ -e "${TMP_DIRECTORY}/${COOKIES}" ] && rm "${TMP_DIRECTORY}/${COOKIES}" ;
}

connection () {
	wget ${WGET_OPTS} ${URL} ;
	case $? in
		4)
			die "> Problem accessing the Freebox. Try to connect manually" ;;
		5)
			die "> SSL problem. Try to connect manually" ;;
	esac
}

cleancook () {
#       Cleanup of the cookie:
        [ -e "${TMP_DIRECTORY}/${COOKIES}" ] && rm "${TMP_DIRECTORY}/${COOKIES}" ;
}

# Function to restart the FreeBox
restart () {
	init ;
	[ -z "${password}" -a -r "${CONFIG_FILE}" ] && . ${CONFIG_FILE} ;
	connection ;
	askpwd ;
	auth ;
#	Restart the freebox:
	wget ${WGET_OPTS} --load-cookies "${TMP_DIRECTORY}/${COOKIES}" --post-data 'method=system.reboot&redirect_after=/reboot.php&timeout=1' -p "${URL}/${FREE_REBOOT_CGI}" ;
	cleancook ;
}

savepass () {
	init ;
	askpwd ;
	auth ;
	echo "password=${password}" > "${CONFIG_FILE}" ;
	chmod 0600 "${CONFIG_FILE}"
	cleancook ;
}

# Main program:
(( $# > 0 )) || { usage ; exit 0; }

while getopts ":p:h" opt ; do
	case ${opt} in
		p)
			password=${OPTARG} ;;
		h)
			usage ; 
			exit 0 ;;
		:)
			echo -e "> Option -$OPTARG requires an argument.\n" ;
			usage ;
			exit 1 ;;
		*)
			echo -e "> Invalid option \"-$OPTARG\".\n" ; 
			usage ;
			exit 1 ;;
	esac
done
shift $((OPTIND-1))

(( $# > 1 )) && { echo -e "> Only one command at a time.\n" ; usage ; exit 1 ; } ;
(( $# < 1 )) && { echo -e "> No command specified.\n" ; usage ; exit 1 ; } ;

case $1 in
	restart)
		restart ;;
	savepass)
		savepass ;;
	*)
		echo -e "> $1 : Unknown command!\n" ;
		usage ;
		exit 1 ;;
esac

Then give it the correct permissions:

1

chmod 555 /bin/freebox

Usage

We’ll save the password for the Freebox interface like this:

1
2

> freebox savepass
Password:

Here is the method to restart the Freebox:

1

freebox reboot

Resources

Edit this page

Last updated 24 Mar 2012, 23:25 +0200. history