push-notify-apn: Send push notifications to mobile iOS devices

[ bsd3, cloud, library, mobile, network, program ] [ Propose Tags ]

push-notify-apn is a library and command line utility that can be used to send push notifications to mobile devices running iOS. Push notifications are small messages that can be sent to apps on smart phones and tablets without the need to keep open a long lived TCP connection per app, dramatically reducing the power consumption in standby mode.


[Skip to Readme]

Modules

[Index]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.0.5, 0.1.0.7, 0.1.0.8, 0.1.1.0, 0.1.2.0, 0.2.0.0, 0.2.0.1, 0.2.0.2, 0.3.0.0, 0.3.0.1, 0.3.0.2
Change log changelog.md
Dependencies aeson, base (>=4.7 && <5), base16-bytestring, binary, bytestring, containers, data-default, http2, http2-client, optparse-applicative, push-notify-apn, random, text, time, tls, x509, x509-store [details]
License BSD-3-Clause
Copyright 2017 Memrange UG
Author Hans-Christian Esperer
Maintainer hc@hcesperer.org
Category Network, Cloud, Mobile
Home page https://github.com/memrange/apn#readme
Source repo head: git clone https://github.com/memrange/push-notify-apn
Uploaded by hc at 2017-09-09T06:49:31Z
Distributions
Executables sendapn
Downloads 5678 total (34 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-09-09 [all 1 reports]

Readme for push-notify-apn-0.1.0.3

[back to package description]

push-notify-apn

push-notify-apn is a library and command line utility that can be used to send push notifications to mobile devices running iOS. Push notifications are small messages that can be sent to apps on smart phones and tablets without the need to keep open a long lived TCP connection per app, dramatically reducing the power consumption in standby mode.

The library is still in an experimental state. Bug and success reports as well as feature and pull requests are very welcome.

Sending a message is as simple as:

let sandbox = True -- Development environment
    timeout = 10   -- Minutes to keep the connection open
session <- newSession "my.key" "my.crt"
    "/etc/ssl/ca_certificates.txt" sandbox
    timeout "my.bundle.id"
let payload = alertMessage "Title" "Hello From Haskell"
    message = newMessage payload
    token   = base16EncodedToken "the-token"
success <- sendMessage session token payload
print success

command line utility

The command line utility can be used for testing your app. Use like this:

sendapn -c ../apn.crt -k ../apn.key -a \
    /etc/ssl/certs/ca-certificates.crt -b your.bundle.id -s \
    -t your-token -m "Your-message"

The -s flag means "sandbox", i.e., for apps that are deployed in a development environment.

credentials

apn.crt and apn.key are the certificate and private key of your APN certificate from apple. To extract them from a .p12 file, use openssl:

openssl pkcs12 -in mycredentials.p12 -out apn.crt -nokeys
openssl pkcs12 -in mycredentials.p12 -nodes -out apn.key -nocerts

ca-certificates.crt is a truststore that contains the root certificates that are used to verify the apn server's server certificates.