La API de S/MIME de Gmail proporciona acceso programático para administrar certificados de correo electrónico S/MIME para los usuarios de un Google Workspace dominio.
Un administrador debe habilitar S/MIME para el dominio para que funcionen los certificados.
El estándar S/MIME proporciona una especificación para la encriptación de claves públicas y la firma de datos MIME. La configuración de certificados S/MIME en la cuenta de un usuario hace que Gmail use ese certificado de las siguientes maneras:
- Gmail usa el certificado y la clave privada del usuario para firmar el correo saliente.
- Gmail usa la clave privada del usuario para desencriptar el correo entrante.
- Gmail usa el certificado y la clave pública del destinatario para encriptar el correo saliente.
- Gmail usa el certificado y la clave pública del remitente para verificar el correo entrante.
Generas certificados S/MIME individuales y los subes con la API. Cada certificado de S/MIME es para un alias específico de una cuenta de correo electrónico de usuario. Los alias incluyen la dirección de correo electrónico principal y las direcciones personalizadas de “Enviar como”. Se marca un solo certificado S/MIME como el predeterminado para cada alias.
Autoriza el acceso a la API
Existen dos formas de autorizar el acceso a la API:
- Puedes usar una cuenta de servicio con delegación de autoridad en todo el dominio. Para obtener una explicación de estos términos, consulta los Términos de la descripción general de la autenticación y la autorización. Para obtener información sobre cómo habilitar esta opción, consulta Cómo crear una cuenta de servicio con delegación de autoridad en todo el dominio.
- Puedes usar un flujo de OAuth2 estándar que requiera el consentimiento del usuario final para obtener un token de acceso de OAuth2. Para obtener más información, consulta la descripción general de la autenticación y la autorización. Para usar esta opción, el administrador del dominio debe habilitar la casilla de verificación "Acceso de usuario final a la API de S/MIME habilitado" en el panel de control del dominio.
Alcances de las LCA
Esta API se basa en los mismos permisos de ACL que los métodos sendAs de Gmail:
- gmail.settings.basic
- Este permiso es obligatorio para actualizar el S/MIME de SendAs principal.
- gmail.settings.sharing
- Este permiso es necesario para actualizar los elementos personalizados desde S/MIME.
Usar la API
El recurso users.settings.sendAs.smimeInfo proporciona los métodos que usas para administrar los certificados S/MIME. Cada certificado está asociado con un alias de envío para un usuario.
Sube una clave S/MIME
Usa el método smimeInfo.insert() para subir una nueva clave S/MIME para un alias que pertenece a un usuario. Para identificar el alias de destino, usa los siguientes parámetros:
- userid
- Es la dirección de correo electrónico del usuario. Puedes usar el valor especial
me
para indicar el usuario autenticado actualmente. - sendAsEmail
- El alias para el que subes la clave. Esta es la dirección de correo electrónico que aparece en el encabezado “De:” de los correos electrónicos enviados con este alias.
El certificado S/MIME y la clave privada deben estar presentes en el campo pkcs12
en ese formato. No se deben configurar otros campos en la solicitud. Se espera que el campo PKCS12 contenga la clave S/MIME del usuario y la cadena de certificados de firma. La API realiza validaciones estándar en este campo antes de aceptarlo y verifica lo siguiente:
- El asunto coincide con la dirección de correo electrónico especificada.
- Las fechas de vencimiento son válidas.
- La autoridad certificadora (AC) emisora está en nuestra lista de confianza.
- Los certificados coinciden con las restricciones técnicas de Gmail.
Si la clave está encriptada, la contraseña debe estar en el campo encryptedKeyPassword
. Las llamadas insert() que se realicen correctamente mostrarán el ID de smimeInfo que se puede usar para hacer referencia a la clave en el futuro.
Cómo mostrar una lista de las claves S/MIME de un usuario
Usa el método smimeInfo.list() para mostrar la lista de claves S/MIME del usuario y el alias determinados. Para identificar el alias de destino, usa los siguientes parámetros:
- userid
- Es la dirección de correo electrónico del usuario. Puedes usar el valor especial
me
para indicar el usuario autenticado actualmente. - sendAsEmail
- Es el alias para el que se enumeran las claves. Esta es la dirección de correo electrónico que aparece en el encabezado “De:” de los correos electrónicos enviados con este alias.
Cómo recuperar las claves S/MIME de un alias
Usa el método smimeInfo.get() para mostrar las claves S/MIME específicas de un alias de envío como de un usuario específico. Para identificar el alias de destino, usa los siguientes parámetros:
- userid
- Es la dirección de correo electrónico del usuario. Puedes usar el valor especial
me
para indicar el usuario autenticado actualmente. - sendAsEmail
- El alias para el que recuperas las claves. Esta es la dirección de correo electrónico que aparece en el encabezado “De:” de los correos electrónicos enviados con este alias.
Borra una clave S/MIME
Usa el método smimeInfo.delete() para borrar la clave S/MIME especificada de un alias. Para identificar el alias de destino, usa los siguientes parámetros:
- userid
- Es la dirección de correo electrónico del usuario. Puedes usar el valor especial
me
para indicar el usuario autenticado actualmente. - sendAsEmail
- El alias para el que recuperas las claves. Esta es la dirección de correo electrónico que aparece en el encabezado "De:" de los correos electrónicos enviados con este alias.
- id
- El ID inmutable para SmimeInfo.
Establece la clave S/MIME predeterminada para un alias
Usa el método smimeInfo.setDefault() para marcar la clave S/MIME especificada como la predeterminada del alias especificado. Para identificar el alias de destino, usa los siguientes parámetros:
- userid
- Es la dirección de correo electrónico del usuario. Puedes usar el valor especial
me
para indicar el usuario autenticado actualmente. - sendAsEmail
- El alias para el que recuperas las claves. Esta es la dirección de correo electrónico que aparece en el encabezado "De:" de los correos electrónicos enviados con este alias.
- id
- El ID inmutable para SmimeInfo.
Código de muestra
En las siguientes muestras de código, se muestra cómo usar la API para administrar certificados S/MIME para una organización con varios usuarios.
Crea un recurso SmimeInfo para un certificado S/MIME
En la siguiente muestra de código, se muestra cómo leer un certificado de un archivo, codificarlo en una cadena base64url y asignarlo al campo pkcs12
del recurso smimeInfo
:
Java
Python
Cómo subir un certificado S/MIME
Para subir un certificado, llama a smimeInfo.insert
y proporciona el recurso smimeInfo
en el cuerpo de la solicitud:
Java
Python
Ejemplos para administrar los certificados de muchos usuarios
Es posible que desees administrar los certificados de muchos usuarios de la organización a la vez. En los siguientes ejemplos, se muestra cómo administrar certificados para varios usuarios en una llamada por lotes.
Cómo insertar certificados desde un archivo CSV
Supongamos que tienes un archivo CSV que enumera los IDs de usuario y la ruta de acceso al certificado de cada usuario:
$ cat certificates.csv
user1@example.com,/path/to/user1_cert.p12,cert_password_1
user2@example.com,/path/to/user2_cert.p12,cert_password_2
user3@example.com,/path/to/user3_cert.p12,cert_password_3
Java
Puedes usar las llamadas createSmimeInfo
y insertSmimeInfo
anteriores para subir los certificados como se especifica en el archivo CSV:
Python
Puedes usar las llamadas create_smime_info
y insert_smime_info
anteriores para subir los certificados como se especifica en el archivo CSV:
Administración de certificados
En este ejemplo, se combinan varias llamadas de la API de smimeInfo
para mostrar cómo podrías administrar los certificados de tu organización. Muestra una lista de los certificados del usuario y, si el certificado predeterminado está vencido o no está configurado, sube el certificado que se encuentra en el archivo especificado. Luego, establece el certificado cuyo vencimiento sea más lejano como el predeterminado.
Luego, se llama a esta función desde una función que procesa un archivo CSV como en el ejemplo anterior.