/[gentoo-x86]/eclass/ssl-cert.eclass
Gentoo

Diff of /eclass/ssl-cert.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.8 Revision 1.19
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2011 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/ssl-cert.eclass,v 1.8 2005/07/06 21:01:21 agriffis Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ssl-cert.eclass,v 1.19 2011/08/22 04:46:32 vapier Exp $
4# 4
5# @ECLASS: ssl-cert.eclass
6# @MAINTAINER:
7# @AUTHOR:
5# Author: Max Kalika <max@gentoo.org> 8# Max Kalika <max@gentoo.org>
6# 9# @BLURB: Eclass for SSL certificates
10# @DESCRIPTION:
7# This eclass implements standard installation procedure for installing 11# This eclass implements a standard installation procedure for installing
8# self-signed SSL certificates. 12# self-signed SSL certificates.
13# @EXAMPLE:
14# "install_cert /foo/bar" installs ${ROOT}/foo/bar.{key,csr,crt,pem}
9 15
10# Conditionally depend on OpenSSL: allows inheretence 16# Conditionally depend on OpenSSL: allows inheretence
11# without pulling extra packages if not needed 17# without pulling extra packages if not needed
12DEPEND="ssl? ( dev-libs/openssl )" 18DEPEND="ssl? ( dev-libs/openssl )"
13IUSE="ssl" 19IUSE="ssl"
14 20
21# @FUNCTION: gen_cnf
22# @USAGE:
23# @DESCRIPTION:
15# Initializes variables and generates the needed 24# Initializes variables and generates the needed
16# OpenSSL configuration file and a CA serial file 25# OpenSSL configuration file and a CA serial file
17# 26#
18# Access: private 27# Access: private
19gen_cnf() { 28gen_cnf() {
20 # Location of the config file 29 # Location of the config file
24 # Location of some random files OpenSSL can use: don't use 33 # Location of some random files OpenSSL can use: don't use
25 # /dev/u?random here -- doesn't work properly on all platforms 34 # /dev/u?random here -- doesn't work properly on all platforms
26 SSL_RANDOM="${T}/environment:${T}/eclass-debug.log:/etc/resolv.conf" 35 SSL_RANDOM="${T}/environment:${T}/eclass-debug.log:/etc/resolv.conf"
27 36
28 # These can be overridden in the ebuild 37 # These can be overridden in the ebuild
29 SSL_DAYS="${SSL_BITS:-730}" 38 SSL_DAYS="${SSL_DAYS:-730}"
30 SSL_BITS="${SSL_BITS:-1024}" 39 SSL_BITS="${SSL_BITS:-1024}"
31 SSL_COUNTRY="${SSL_COUNTRY:-US}" 40 SSL_COUNTRY="${SSL_COUNTRY:-US}"
32 SSL_STATE="${SSL_STATE:-California}" 41 SSL_STATE="${SSL_STATE:-California}"
33 SSL_LOCALITY="${SSL_LOCALITY:-Santa Barbara}" 42 SSL_LOCALITY="${SSL_LOCALITY:-Santa Barbara}"
34 SSL_ORGANIZATION="${SSL_ORGANIZATION:-SSL Server}" 43 SSL_ORGANIZATION="${SSL_ORGANIZATION:-SSL Server}"
38 47
39 # Create the CA serial file 48 # Create the CA serial file
40 echo "01" > "${SSL_SERIAL}" 49 echo "01" > "${SSL_SERIAL}"
41 50
42 # Create the config file 51 # Create the config file
43 ebegin "Generating OpenSSL configuration" 52 ebegin "Generating OpenSSL configuration${1:+ for CA}"
44 cat <<-EOF > "${SSL_CONF}" 53 cat <<-EOF > "${SSL_CONF}"
45 [ req ] 54 [ req ]
46 prompt = no 55 prompt = no
47 default_bits = ${SSL_BITS} 56 default_bits = ${SSL_BITS}
48 distinguished_name = req_dn 57 distinguished_name = req_dn
50 C = ${SSL_COUNTRY} 59 C = ${SSL_COUNTRY}
51 ST = ${SSL_STATE} 60 ST = ${SSL_STATE}
52 L = ${SSL_LOCALITY} 61 L = ${SSL_LOCALITY}
53 O = ${SSL_ORGANIZATION} 62 O = ${SSL_ORGANIZATION}
54 OU = ${SSL_UNIT} 63 OU = ${SSL_UNIT}
55 CN = ${SSL_COMMONNAME} 64 CN = ${SSL_COMMONNAME}${1:+ CA}
56 emailAddress = ${SSL_EMAIL} 65 emailAddress = ${SSL_EMAIL}
57 EOF 66 EOF
58 eend $? 67 eend $?
59
60 return $?
61}
62 68
69 return $?
70}
71
72# @FUNCTION: get_base
73# @USAGE: [if_ca]
74# @RETURN: <base path>
75# @DESCRIPTION:
63# Simple function to determine whether we're creating 76# Simple function to determine whether we're creating
64# a CA (which should only be done once) or final part 77# a CA (which should only be done once) or final part
65# 78#
66# Access: private 79# Access: private
67get_base() { 80get_base() {
70 else 83 else
71 echo "${T}/${$}server" 84 echo "${T}/${$}server"
72 fi 85 fi
73} 86}
74 87
88# @FUNCTION: gen_key
89# @USAGE: <base path>
90# @DESCRIPTION:
75# Generates an RSA key 91# Generates an RSA key
76# 92#
77# Access: private 93# Access: private
78gen_key() { 94gen_key() {
79 local base=`get_base $1` 95 local base=`get_base $1`
83 eend $? 99 eend $?
84 100
85 return $? 101 return $?
86} 102}
87 103
104# @FUNCTION: gen_csr
105# @USAGE: <base path>
106# @DESCRIPTION:
88# Generates a certificate signing request using 107# Generates a certificate signing request using
89# the key made by gen_key() 108# the key made by gen_key()
90# 109#
91# Access: private 110# Access: private
92gen_csr() { 111gen_csr() {
97 eend $? 116 eend $?
98 117
99 return $? 118 return $?
100} 119}
101 120
121# @FUNCTION: gen_crt
122# @USAGE: <base path>
123# @DESCRIPTION:
102# Generates either a self-signed CA certificate using 124# Generates either a self-signed CA certificate using
103# the csr and key made by gen_csr() and gen_key() or 125# the csr and key made by gen_csr() and gen_key() or
104# a signed server certificate using the CA cert previously 126# a signed server certificate using the CA cert previously
105# created by gen_crt() 127# created by gen_crt()
106# 128#
123 eend $? 145 eend $?
124 146
125 return $? 147 return $?
126} 148}
127 149
150# @FUNCTION: gen_pem
151# @USAGE: <base path>
152# @DESCRIPTION:
128# Generates a PEM file by concatinating the key 153# Generates a PEM file by concatinating the key
129# and cert file created by gen_key() and gen_cert() 154# and cert file created by gen_key() and gen_cert()
130# 155#
131# Access: private 156# Access: private
132gen_pem() { 157gen_pem() {
136 eend $? 161 eend $?
137 162
138 return $? 163 return $?
139} 164}
140 165
166# Removed due to bug 174759
167docert() {
168 eerror "Function \"docert\" has been removed for security reasons."
169 eerror "\"install_cert\" should be used instead. See bug 174759."
170 die
171}
172
173# @FUNCTION: install_cert
174# @USAGE: <certificates>
175# @DESCRIPTION:
141# Uses all the private functions above to generate 176# Uses all the private functions above to generate and install the
142# and install the requested certificates 177# requested certificates.
178# <certificates> are full pathnames relative to ROOT, without extension.
179#
180# Example: "install_cert /foo/bar" installs ${ROOT}/foo/bar.{key,csr,crt,pem}
143# 181#
144# Access: public 182# Access: public
145docert() { 183install_cert() {
146 if [ $# -lt 1 ] ; then 184 if [ $# -lt 1 ] ; then
147 eerror "At least one argument needed" 185 eerror "At least one argument needed"
148 return 1; 186 return 1;
149 fi 187 fi
150 188
151 # Initialize configuration 189 case ${EBUILD_PHASE} in
190 unpack|compile|test|install)
191 eerror "install_cert cannot be called in ${EBUILD_PHASE}"
192 return 1 ;;
193 esac
194
195 # Generate a CA environment #164601
152 gen_cnf || return 1 196 gen_cnf 1 || return 1
153 echo
154
155 # Generate a CA environment
156 gen_key 1 || return 1 197 gen_key 1 || return 1
157 gen_csr 1 || return 1 198 gen_csr 1 || return 1
158 gen_crt 1 || return 1 199 gen_crt 1 || return 1
159 echo 200 echo
160 201
202 gen_cnf || return 1
203 echo
204
161 local count=0 205 local count=0
162 for cert in "$@" ; do 206 for cert in "$@" ; do
163 # Sanitize and check the requested certificate 207 # Check the requested certificate
164 cert="`/usr/bin/basename "${cert}"`"
165 if [ -z "${cert}" ] ; then 208 if [ -z "${cert##*/}" ] ; then
166 ewarn "Invalid certification requested, skipping" 209 ewarn "Invalid certification requested, skipping"
167 continue 210 continue
168 fi 211 fi
169 212
170 # Check for previous existence of generated files 213 # Check for previous existence of generated files
171 for type in key crt pem ; do 214 for type in key csr crt pem ; do
172 if [ -e "${D}${INSDESTTREE}/${cert}.${type}" ] ; then 215 if [ -e "${ROOT}${cert}.${type}" ] ; then
173 ewarn "${D}${INSDESTTREE}/${cert}.${type}: exists, skipping" 216 ewarn "${ROOT}${cert}.${type}: exists, skipping"
174 continue 2 217 continue 2
175 fi 218 fi
176 done 219 done
177 220
178 # Generate the requested files 221 # Generate the requested files
181 gen_crt || continue 224 gen_crt || continue
182 gen_pem || continue 225 gen_pem || continue
183 echo 226 echo
184 227
185 # Install the generated files and set sane permissions 228 # Install the generated files and set sane permissions
186 local base=`get_base` 229 local base=$(get_base)
230 install -d "${ROOT}${cert%/*}"
187 newins "${base}.key" "${cert}.key" 231 install -m0400 "${base}.key" "${ROOT}${cert}.key"
188 fperms 0400 "${INSDESTTREE}/${cert}.key"
189 newins "${base}.csr" "${cert}.csr" 232 install -m0444 "${base}.csr" "${ROOT}${cert}.csr"
190 fperms 0444 "${INSDESTTREE}/${cert}.csr"
191 newins "${base}.crt" "${cert}.crt" 233 install -m0444 "${base}.crt" "${ROOT}${cert}.crt"
192 fperms 0444 "${INSDESTTREE}/${cert}.crt"
193 newins "${base}.pem" "${cert}.pem" 234 install -m0400 "${base}.pem" "${ROOT}${cert}.pem"
194 fperms 0400 "${INSDESTTREE}/${cert}.pem"
195 count=$((${count}+1)) 235 count=$((${count}+1))
196 done 236 done
197 237
198 # Resulting status 238 # Resulting status
199 if [ ! ${count} ] ; then 239 if [ ${count} = 0 ] ; then
200 eerror "No certificates were generated" 240 eerror "No certificates were generated"
201 return 1 241 return 1
202 elif [ ${count} != ${#} ] ; then 242 elif [ ${count} != ${#} ] ; then
203 ewarn "Some requested certificates were not generated" 243 ewarn "Some requested certificates were not generated"
204 fi 244 fi

Legend:
Removed from v.1.8  
changed lines
  Added in v.1.19

  ViewVC Help
Powered by ViewVC 1.1.20